English documentation updates up to v0.8.25-46-g6c7e686d8 (2024-04-13)

CMakeLists.txt

@@ -1,11 +1,11 @@
 cmake_minimum_required(VERSION 3.13.0)
 
-set(ETH_CMAKE_DIR   "${CMAKE_CURRENT_LIST_DIR}/cmake"   CACHE PATH "The the path to the cmake directory")
+set(ETH_CMAKE_DIR   "${CMAKE_CURRENT_LIST_DIR}/cmake"   CACHE PATH "The path to the cmake directory")
 list(APPEND CMAKE_MODULE_PATH ${ETH_CMAKE_DIR})
 
 # Set the build type, if none was specified.
 if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
-	if(EXISTS "${CMAKE_SOURCE_DIR}/.git")
+	if(EXISTS "${PROJECT_SOURCE_DIR}/.git")
 		set(DEFAULT_BUILD_TYPE "RelWithDebInfo")
 	else()
 		set(DEFAULT_BUILD_TYPE "Release")
@@ -21,7 +21,7 @@ include(EthPolicy)
 eth_policy()
 
 # project name and version should be set after cmake_policy CMP0048
-set(PROJECT_VERSION "0.8.20")
+set(PROJECT_VERSION "0.8.26")
 # OSX target needed in order to support std::visit
 set(CMAKE_OSX_DEPLOYMENT_TARGET "10.14")
 project(solidity VERSION ${PROJECT_VERSION} LANGUAGES C CXX)
@@ -37,16 +37,21 @@ option(SOLC_STATIC_STDLIBS "Link solc against static versions of libgcc and libs
 option(STRICT_Z3_VERSION "Use the latest version of Z3" ON)
 option(PEDANTIC "Enable extra warnings and pedantic build flags. Treat all warnings as errors." ON)
 option(PROFILE_OPTIMIZER_STEPS "Output performance metrics for the optimiser steps." OFF)
+option(USE_SYSTEM_LIBRARIES "Use system libraries" OFF)
+option(ONLY_BUILD_SOLIDITY_LIBRARIES "Only build solidity libraries" OFF)
+option(STRICT_JSONCPP_VERSION "Strictly check installed jsoncpp version" ON)
 
 # Setup cccache.
 include(EthCcache)
 
 # Let's find our dependencies
 include(EthDependencies)
-include(fmtlib)
-include(jsoncpp)
-include(range-v3)
-include_directories(SYSTEM ${JSONCPP_INCLUDE_DIR})
+if (NOT USE_SYSTEM_LIBRARIES)
+  include(fmtlib)
+  include(jsoncpp)
+  include(range-v3)
+  include_directories(SYSTEM ${JSONCPP_INCLUDE_DIR})
+endif()
 
 find_package(Threads)
 
@@ -58,6 +63,10 @@ if (PROFILE_OPTIMIZER_STEPS)
     add_definitions(-DPROFILE_OPTIMIZER_STEPS)
 endif()
 
+if (STRICT_JSONCPP_VERSION)
+	add_definitions(-DSTRICT_JSONCPP_VERSION_CHECK)
+endif()
+
 # Figure out what compiler and system are we using
 include(EthCompilerSettings)
 
@@ -66,12 +75,12 @@ include(EthUtils)
 
 # Create license.h from LICENSE.txt and template
 # Converting to char array is required due to MSVC's string size limit.
-file(READ ${CMAKE_SOURCE_DIR}/LICENSE.txt LICENSE_TEXT HEX)
+file(READ ${PROJECT_SOURCE_DIR}/LICENSE.txt LICENSE_TEXT HEX)
 string(REGEX MATCHALL ".." LICENSE_TEXT "${LICENSE_TEXT}")
 string(REGEX REPLACE ";" ",\n\t0x" LICENSE_TEXT "${LICENSE_TEXT}")
 set(LICENSE_TEXT "0x${LICENSE_TEXT}")
 
-configure_file("${CMAKE_SOURCE_DIR}/cmake/templates/license.h.in" include/license.h)
+configure_file("${PROJECT_SOURCE_DIR}/cmake/templates/license.h.in" include/license.h)
 
 include(EthOptions)
 configure_project(TESTS)
@@ -140,12 +149,17 @@ add_subdirectory(libevmasm)
 add_subdirectory(libyul)
 add_subdirectory(libsolidity)
 add_subdirectory(libsolc)
-add_subdirectory(tools)
+add_subdirectory(libstdlib)
 
-if (NOT EMSCRIPTEN)
-	add_subdirectory(solc)
-endif()
+if (NOT ONLY_BUILD_SOLIDITY_LIBRARIES)
+	add_subdirectory(tools)
 
-if (TESTS AND NOT EMSCRIPTEN)
-	add_subdirectory(test)
+	if (NOT EMSCRIPTEN)
+		add_subdirectory(solc)
+	endif()
+
+	if (TESTS AND NOT EMSCRIPTEN)
+		add_subdirectory(test)
+	endif()
 endif()
+

docs/050-breaking-changes.rst

@@ -114,13 +114,19 @@ Solidity v0.5.0 突破性变化
 * 在非payable函数中使用 ``msg.value`` （或通过修改器引入）是不允许的，因为这是一个安全特性。
   将该函数变成 ``payable``，或为程序逻辑创建一个新的内部函数，使用 ``msg.value``。
 
+<<<<<<< HEAD
 * 为了清晰起见，如果使用标准输入作为源，命令行界面现在需要 ``-``。
+=======
+* For clarity reasons, the command-line interface now requires ``-`` if the
+  standard input is used as source.
+>>>>>>> english/develop
 
 废弃的元素
 ===================
 
 这一节列出了废弃以前的功能或语法的变化。 请注意，其中许多变化已经在实验模式 ``v0.5.0`` 中启用。
 
+<<<<<<< HEAD
 命令行和JSON接口
 --------------------------------
 
@@ -130,6 +136,21 @@ Solidity v0.5.0 突破性变化
 * 由于中间语言 ``Julia`` 更名为 ``Yul``，命令行选项 ``--julia`` 被更名为 ``--yul``。
 
 * 删除了 ``--clone-bin`` 和 ``--combined-json clone-bin`` 命令行选项。
+=======
+Command-line and JSON Interfaces
+--------------------------------
+
+* The command-line option ``--formal`` (used to generate Why3 output for
+  further formal verification) was deprecated and is now removed.  A new
+  formal verification module, the SMTChecker, is enabled via ``pragma
+  experimental SMTChecker;``.
+
+* The command-line option ``--julia`` was renamed to ``--yul`` due to the
+  renaming of the intermediate language ``Julia`` to ``Yul``.
+
+* The ``--clone-bin`` and ``--combined-json clone-bin`` command-line options
+  were removed.
+>>>>>>> english/develop
 
 * 不允许使用空前缀的重映射。
 

docs/060-breaking-changes.rst

@@ -9,7 +9,12 @@ Solidity 0.6.0 版本突破性变化
 编译器可能不会发出警告的变化
 =========================================
 
+<<<<<<< HEAD
 本节列出了一些变化，在这些变化中，您的代码的行为可能会发生变化，而编译器不会告诉您。
+=======
+This section lists changes where the behavior of your code might
+change without the compiler telling you about it.
+>>>>>>> english/develop
 
 * 指数运算的结果类型是基数的类型。
   就像对称运算一样，它曾经是可以同时容纳基数类型和指数类型的最小类型。
@@ -90,25 +95,45 @@ Solidity 0.6.0 版本突破性变化
 接口变化
 =================
 
+<<<<<<< HEAD
 本节列出与语言本身无关但对编译器接口有影响的更改。
 这些可能会改变您在命令行上使用编译器的方式，例如，您如何使用它的可编程接口，
 或者您如何分析它产生的输出。
+=======
+This section lists changes that are unrelated to the language itself, but that have an effect on the interfaces of
+the compiler. These may change the way how you use the compiler on the command-line, how you use its programmable
+interface, or how you analyze the output produced by it.
+>>>>>>> english/develop
 
 新的错误报告器
 ~~~~~~~~~~~~~~~~~~
 
+<<<<<<< HEAD
 引入一个新的错误报告器，其目的是在命令行上产生更易访问的错误消息。
 它在默认情况下是启用的，但是通过 ``--old-reporter`` 可以返回到弃用的旧错误报告器。
+=======
+A new error reporter was introduced, which aims at producing more accessible error messages on the command-line.
+It is enabled by default, but passing ``--old-reporter`` falls back to the deprecated old error reporter.
+>>>>>>> english/develop
 
 元数据哈希选项
 ~~~~~~~~~~~~~~~~~~~~~
 
+<<<<<<< HEAD
 编译器现在默认将元数据文件的 `IPFS <https://ipfs.io/>`_ 哈希值附加到字节码的末尾
 （详见 :doc:`合约元数据 <metadata>` ） 文档。在0.6.0之前，
 编译器默认附加了 `Swarm <https://ethersphere.github.io/swarm-home/>`_ 哈希值，
 为了仍然支持这种行为，引入了新的命令行选项 ``--metadata-hash``。
 它允许您通过传递 ``--metadata-hash`` 命令行选项的 ``ipfs`` 或 ``swarm`` 值来选择要产生和附加的哈希。
 传递 ``none`` 则可以完全删除哈希。
+=======
+The compiler now appends the `IPFS <https://ipfs.io/>`_ hash of the metadata file to the end of the bytecode by default
+(for details, see documentation on :doc:`contract metadata <metadata>`). Before 0.6.0, the compiler appended the
+`Swarm <https://ethersphere.github.io/swarm-home/>`_ hash by default, and in order to still support this behavior,
+the new command-line option ``--metadata-hash`` was introduced. It allows you to select the hash to be produced and
+appended, by passing either ``ipfs`` or ``swarm`` as value to the ``--metadata-hash`` command-line option.
+Passing the value ``none`` completely removes the hash.
+>>>>>>> english/develop
 
 这些变化也可以通过 :ref:`标准JSON接口 <compiler-api>` 使用，并影响编译器生成的元数据JSON。
 

docs/080-breaking-changes.rst

@@ -8,18 +8,32 @@ Solidity v0.8.0 突破性变化
 语义的微小变化
 ===============================
 
+<<<<<<< HEAD
 本节列出了现有代码在编译器没有通知您的情况下改变其行为的更改。
 
 * 算术操作在下溢和溢出时都会恢复。您可以使用 ``unchecked { ... }`` 来使用以前的包装行为。
+=======
+This section lists changes where existing code changes its behavior without
+the compiler notifying you about it.
+
+* Arithmetic operations revert on underflow and overflow. You can use ``unchecked { ... }`` to use
+  the previous wrapping behavior.
+>>>>>>> english/develop
 
   溢出的检查是非常普遍的，所以我们把它作为默认的检查，
   以增加代码的可读性，即使它是以略微增加gas成本为代价的。
 
 * ABI编码器v2默认是激活的。
 
+<<<<<<< HEAD
   您可以使用 ``pragma abicoder v1;`` 来选择使用旧的行为。
   语句 ``pragma experimental ABIEncoderV2;`` 仍然有效，但它已被废弃，没有效果。
   如果您想显示使用，请使用 ``pragma abicoder v2;`` 代替。
+=======
+  You can choose to use the old behavior using ``pragma abicoder v1;``.
+  The pragma ``pragma experimental ABIEncoderV2;`` is still valid, but it is deprecated and has no effect.
+  If you want to be explicit, please use ``pragma abicoder v2;`` instead.
+>>>>>>> english/develop
 
   请注意，ABI coder v2比v1支持更多的类型，并对输入进行更多的合理性检查。
   ABI coder v2使一些函数调用更加昂贵，而且当合约中包含不符合参数类型的数据时，它还会使合约调用回退，
@@ -49,7 +63,12 @@ Solidity v0.8.0 突破性变化
 
 本节列出了可能导致现有合约不再编译的变化。
 
+<<<<<<< HEAD
 * 有一些与字面常量的显式转换有关的新限制。以前在以下情况下的行为可能是模糊的：
+=======
+* There are new restrictions related to explicit conversions of literals. The previous behavior in
+  the following cases was likely ambiguous:
+>>>>>>> english/develop
 
   1. 不允许从负数字段和大于 ``type(uint160).max`` 的字段显式转换为 ``address``。
   2. 只有当字面常量位于 ``type(T).min`` 和 ``type(T).max`` 之间时，
@@ -90,7 +109,11 @@ Solidity v0.8.0 突破性变化
 
 * 全局函数 ``log0``， ``log1``， ``log2``， ``log3`` 和 ``log4`` 已被删除。
 
+<<<<<<< HEAD
   这些都是低级别的函数，基本上没有被使用过。它们的行为可以通过内联汇编访问。
+=======
+  These are low-level functions that were largely unused. Their behavior can be accessed from inline assembly.
+>>>>>>> english/develop
 
 * ``enum`` 定义包含的成员不能超过256个。
 

docs/README.md

@@ -0,0 +1,23 @@
+# Solidity Language Docs
+
+## Local environment setup
+
+1. Install python https://www.python.org/downloads/
+1. Install sphinx (the tool used to generate the docs) https://www.sphinx-doc.org/en/master/usage/installation.html
+
+Go to `/docs` and run `./docs.sh` to install dependencies and build the project:
+
+```sh
+cd docs
+./docs.sh
+```
+
+That will output the generated htmls under _build/
+
+## Serve environment
+
+```py
+python3 -m http.server -d _build/html --cgi 8080
+```
+
+Visit dev server at http://localhost:8080