Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

English documentation updates up to v0.8.17 (2023-04-06) #100

Open
wants to merge 182 commits into
base: develop
Choose a base branch
from

Conversation

r0qs
Copy link
Contributor

@r0qs r0qs commented Apr 6, 2023

This is a manually created sync PR that will bring the docs in this repository exactly to the state as of 0.8.17.

LCamel and others added 30 commits July 26, 2022 15:53
Co-authored-by: Daniel Kirchner <daniel@ekpyron.org>
The solidity docs and [Inline assembly memory management](https://docs.soliditylang.org/en/v0.8.15/assembly.html#memory-management) suggest the actual allocate-able memory starts from `0x80`. The above yul example defaults the free memory pointer to `0x60` in initialisation cases.
…or-on-update

`update_bugs_by_version.py`: don't fail when the list gets updated
Docs — Minor grammar fixes in `abi-spec.rst`
…InDocs

[Docs] Fixed link to internal-function-calls
cameel and others added 29 commits September 5, 2022 18:13
…tweaks

Release checklist update and tweaks after 0.8.16
Add comment to pinned GP2 hardhat version
…liquidator-tests

Pin hardhat version in yield-liquidator tests
…izer

Add note about peephole optimizer in docs
Co-authored-by: Kamil Śliwak <kamil.sliwak@codepoets.it>
Co-authored-by: Kamil Śliwak <kamil.sliwak@codepoets.it>
Fix of unused store remover storage bug.
# Conflicts:
#	.circleci/config.yml
#	.circleci/osx_install_dependencies.sh
#	.github/ISSUE_TEMPLATE/config.yml
#	.github/ISSUE_TEMPLATE/feature_request.md
#	.github/workflows/buildpack-deps.yml
#	.gitignore
#	CMakeLists.txt
#	Changelog.md
#	README.md
#	ReleaseChecklist.md
#	cmake/EthCompilerSettings.cmake
#	cmake/EthPolicy.cmake
#	docs/abi-spec.rst
#	docs/assembly.rst
#	docs/contracts/function-modifiers.rst
#	docs/contracts/functions.rst
#	docs/contributing.rst
#	docs/control-structures.rst
#	docs/examples/voting.rst
#	docs/installing-solidity.rst
#	docs/internals/optimizer.rst
#	docs/introduction-to-smart-contracts.rst
#	docs/layout-of-source-files.rst
#	docs/metadata.rst
#	docs/security-considerations.rst
#	docs/types/operators.rst
#	docs/types/reference-types.rst
#	docs/types/value-types.rst
#	docs/using-the-compiler.rst
#	libevmasm/Assembly.cpp
#	libevmasm/CommonSubexpressionEliminator.cpp
#	libevmasm/ConstantOptimiser.cpp
#	libevmasm/ControlFlowGraph.cpp
#	libevmasm/Inliner.cpp
#	libevmasm/KnownState.cpp
#	libevmasm/KnownState.h
#	libevmasm/PathGasMeter.cpp
#	liblangutil/Scanner.cpp
#	libsmtutil/CHCSmtLib2Interface.cpp
#	libsmtutil/SMTLib2Interface.cpp
#	libsmtutil/SMTPortfolio.cpp
#	libsmtutil/Z3CHCInterface.cpp
#	libsolc/libsolc.cpp
#	libsolidity/analysis/DeclarationContainer.cpp
#	libsolidity/analysis/FunctionCallGraph.cpp
#	libsolidity/analysis/NameAndTypeResolver.cpp
#	libsolidity/analysis/ReferencesResolver.cpp
#	libsolidity/analysis/TypeChecker.cpp
#	libsolidity/ast/AST.cpp
#	libsolidity/ast/AST.h
#	libsolidity/ast/ASTJsonExporter.cpp
#	libsolidity/ast/ASTJsonImporter.cpp
#	libsolidity/ast/TypeProvider.cpp
#	libsolidity/ast/Types.cpp
#	libsolidity/ast/Types.h
#	libsolidity/codegen/CompilerContext.cpp
#	libsolidity/codegen/ContractCompiler.cpp
#	libsolidity/codegen/ExpressionCompiler.cpp
#	libsolidity/codegen/ExpressionCompiler.h
#	libsolidity/codegen/LValue.cpp
#	libsolidity/codegen/MultiUseYulFunctionCollector.cpp
#	libsolidity/codegen/YulUtilFunctions.cpp
#	libsolidity/codegen/ir/IRGenerationContext.cpp
#	libsolidity/codegen/ir/IRGenerator.cpp
#	libsolidity/codegen/ir/IRGeneratorForStatements.cpp
#	libsolidity/formal/ArraySlicePredicate.cpp
#	libsolidity/formal/BMC.cpp
#	libsolidity/formal/CHC.cpp
#	libsolidity/formal/EncodingContext.cpp
#	libsolidity/formal/EncodingContext.h
#	libsolidity/formal/Invariants.cpp
#	libsolidity/formal/ModelChecker.cpp
#	libsolidity/formal/Predicate.cpp
#	libsolidity/formal/SMTEncoder.cpp
#	libsolidity/formal/SymbolicState.cpp
#	libsolidity/formal/SymbolicVariables.cpp
#	libsolidity/interface/ABI.cpp
#	libsolidity/interface/CompilerStack.cpp
#	libsolidity/interface/ImportRemapper.cpp
#	libsolidity/interface/Natspec.cpp
#	libsolidity/interface/StandardCompiler.cpp
#	libsolidity/interface/StorageLayout.cpp
#	libsolidity/lsp/FileRepository.cpp
#	libsolidity/lsp/GotoDefinition.cpp
#	libsolidity/lsp/LanguageServer.cpp
#	libsolidity/lsp/LanguageServer.h
#	libsolidity/lsp/Transport.cpp
#	libsolidity/parsing/DocStringParser.cpp
#	libsolidity/parsing/Parser.cpp
#	libsolutil/StringUtils.h
#	libsolutil/Whiskers.cpp
#	libyul/AsmParser.cpp
#	libyul/AsmPrinter.cpp
#	libyul/ControlFlowSideEffectsCollector.cpp
#	libyul/ObjectParser.cpp
#	libyul/backends/evm/ConstantOptimiser.cpp
#	libyul/backends/evm/ControlFlowGraph.h
#	libyul/backends/evm/ControlFlowGraphBuilder.cpp
#	libyul/backends/evm/EVMCodeTransform.cpp
#	libyul/backends/evm/EVMDialect.cpp
#	libyul/backends/evm/EthAssemblyAdapter.cpp
#	libyul/backends/evm/OptimizedEVMCodeTransform.cpp
#	libyul/backends/evm/StackLayoutGenerator.cpp
#	libyul/backends/wasm/BinaryTransform.cpp
#	libyul/backends/wasm/EVMToEwasmTranslator.cpp
#	libyul/backends/wasm/TextTransform.cpp
#	libyul/backends/wasm/WasmCodeTransform.cpp
#	libyul/backends/wasm/WasmDialect.cpp
#	libyul/optimiser/ConditionalSimplifier.h
#	libyul/optimiser/DataFlowAnalyzer.cpp
#	libyul/optimiser/DataFlowAnalyzer.h
#	libyul/optimiser/DeadCodeEliminator.h
#	libyul/optimiser/ExpressionSimplifier.cpp
#	libyul/optimiser/ExpressionSimplifier.h
#	libyul/optimiser/ForLoopInitRewriter.cpp
#	libyul/optimiser/FullInliner.cpp
#	libyul/optimiser/FunctionSpecializer.cpp
#	libyul/optimiser/KnowledgeBase.cpp
#	libyul/optimiser/NameDispenser.cpp
#	libyul/optimiser/NameSimplifier.cpp
#	libyul/optimiser/ReasoningBasedSimplifier.cpp
#	libyul/optimiser/StackCompressor.cpp
#	libyul/optimiser/StackToMemoryMover.cpp
#	libyul/optimiser/UnusedFunctionParameterPruner.cpp
#	libyul/optimiser/UnusedStoreBase.cpp
#	libyul/optimiser/UnusedStoreEliminator.cpp
#	scripts/build_emscripten.sh
#	scripts/check_style.sh
#	scripts/ci/build_emscripten.sh
#	scripts/codespell_whitelist.txt
#	scripts/common.sh
#	scripts/common/rest_api_helpers.py
#	scripts/deps-ppa/static_z3.sh
#	scripts/docker/buildpack-deps/Dockerfile.emscripten
#	scripts/docker/buildpack-deps/Dockerfile.ubuntu1604.clang.ossfuzz
#	scripts/docker/buildpack-deps/Dockerfile.ubuntu2004
#	scripts/docker/buildpack-deps/Dockerfile.ubuntu2004.clang
#	scripts/docker/buildpack-deps/README.md
#	scripts/gas_diff_stats.py
#	scripts/release_ppa.sh
#	scripts/update_bugs_by_version.py
#	solc/CommandLineInterface.cpp
#	solc/CommandLineParser.cpp
#	test/CommonSyntaxTest.cpp
#	test/EVMHost.cpp
#	test/Metadata.cpp
#	test/TestCaseReader.cpp
#	test/cmdlineTests.sh
#	test/cmdlineTests/debug_info_in_yul_and_evm_asm_print_all/output
#	test/cmdlineTests/debug_info_in_yul_and_evm_asm_print_location_only/output
#	test/cmdlineTests/debug_info_in_yul_and_evm_asm_print_none/output
#	test/cmdlineTests/ir_compiler_subobjects/output
#	test/cmdlineTests/ir_with_assembly_no_memoryguard_creation/output
#	test/cmdlineTests/ir_with_assembly_no_memoryguard_runtime/output
#	test/cmdlineTests/standard_debug_info_in_yul_and_evm_asm_print_all/output.json
#	test/cmdlineTests/standard_debug_info_in_yul_and_evm_asm_print_location_only/output.json
#	test/cmdlineTests/standard_debug_info_in_yul_and_evm_asm_print_none/output.json
#	test/cmdlineTests/viair_subobjects/output
#	test/externalTests/README.md
#	test/externalTests/bleeps.sh
#	test/externalTests/chainlink.sh
#	test/externalTests/common.sh
#	test/externalTests/gnosis.sh
#	test/externalTests/gp2.sh
#	test/externalTests/yield-liquidator.sh
#	test/externalTests/zeppelin.sh
#	test/formal/checked_uint_mul_12.py
#	test/formal/util.py
#	test/libevmasm/Optimiser.cpp
#	test/liblangutil/Scanner.cpp
#	test/libsolidity/GasTest.cpp
#	test/libsolidity/SMTCheckerTest.cpp
#	test/libsolidity/SemanticTest.cpp
#	test/libsolidity/SolidityExecutionFramework.cpp
#	test/libsolidity/SolidityExpressionCompiler.cpp
#	test/libsolidity/semanticTests/abiEncoderV1/abi_encode_calldata_slice.sol
#	test/libsolidity/semanticTests/abiEncoderV2/abi_encode_calldata_slice.sol
#	test/libsolidity/semanticTests/abiEncoderV2/calldata_nested_array_reencode.sol
#	test/libsolidity/semanticTests/abiEncoderV2/storage_array_encoding.sol
#	test/libsolidity/semanticTests/array/copying/array_copy_including_array.sol
#	test/libsolidity/semanticTests/array/copying/array_copy_nested_array.sol
#	test/libsolidity/semanticTests/array/copying/array_copy_storage_storage_dyn_dyn.sol
#	test/libsolidity/semanticTests/array/copying/array_copy_storage_storage_struct.sol
#	test/libsolidity/semanticTests/array/copying/array_copy_target_leftover.sol
#	test/libsolidity/semanticTests/array/copying/array_nested_calldata_to_storage.sol
#	test/libsolidity/semanticTests/array/copying/array_of_struct_calldata_to_storage.sol
#	test/libsolidity/semanticTests/array/copying/function_type_array_to_storage.sol
#	test/libsolidity/semanticTests/array/dynamic_array_cleanup.sol
#	test/libsolidity/semanticTests/array/dynamic_arrays_in_storage.sol
#	test/libsolidity/semanticTests/array/fixed_array_cleanup.sol
#	test/libsolidity/semanticTests/array/pop/byte_array_pop_long_storage_empty_garbage_ref.sol
#	test/libsolidity/semanticTests/array/push/nested_bytes_push.sol
#	test/libsolidity/semanticTests/array/push/push_no_args_2d.sol
#	test/libsolidity/semanticTests/array/push/push_no_args_bytes.sol
#	test/libsolidity/semanticTests/events/event_dynamic_array_storage.sol
#	test/libsolidity/semanticTests/events/event_dynamic_array_storage_v2.sol
#	test/libsolidity/semanticTests/events/event_dynamic_nested_array_storage_v2.sol
#	test/libsolidity/semanticTests/events/event_emit_from_other_contract.sol
#	test/libsolidity/semanticTests/events/event_indexed_string.sol
#	test/libsolidity/semanticTests/externalContracts/FixedFeeRegistrar.sol
#	test/libsolidity/semanticTests/externalContracts/_prbmath/PRBMathCommon.sol
#	test/libsolidity/semanticTests/externalContracts/_prbmath/PRBMathUD60x18.sol
#	test/libsolidity/semanticTests/externalContracts/base64.sol
#	test/libsolidity/semanticTests/externalContracts/ramanujan_pi.sol
#	test/libsolidity/semanticTests/externalContracts/snark.sol
#	test/libsolidity/semanticTests/externalContracts/strings.sol
#	test/libsolidity/semanticTests/functionCall/gas_and_value_basic.sol
#	test/libsolidity/semanticTests/functionCall/gas_and_value_brace_syntax.sol
#	test/libsolidity/semanticTests/salted_create/salted_create_with_value.sol
#	test/libsolidity/semanticTests/structs/struct_delete_storage_with_array.sol
#	test/libsolidity/semanticTests/structs/structs.sol
#	test/libsolidity/semanticTests/userDefinedValueType/calldata.sol
#	test/libsolidity/semanticTests/various/contract_binary_dependencies.sol
#	test/libsolidity/semanticTests/various/swap_in_storage_overwrite.sol
#	test/libsolidity/semanticTests/viaYul/array_storage_index_access.sol
#	test/libsolidity/semanticTests/viaYul/array_storage_index_zeroed_test.sol
#	test/libsolidity/semanticTests/viaYul/array_storage_push_empty.sol
#	test/libsolidity/semanticTests/viaYul/copy_struct_invalid_ir_bug.sol
#	test/libsolidity/semanticTests/viaYul/detect_mul_overflow_signed.sol
#	test/libsolidity/smtCheckerTests/abi/abi_encode_packed_hash.sol
#	test/libsolidity/smtCheckerTests/abi/abi_encode_with_selector_hash.sol
#	test/libsolidity/smtCheckerTests/abi/abi_encode_with_selector_vs_sig.sol
#	test/libsolidity/smtCheckerTests/abi/abi_encode_with_sig_hash.sol
#	test/libsolidity/smtCheckerTests/abi/abi_encode_with_sig_simple.sol
#	test/libsolidity/smtCheckerTests/array_members/push_as_lhs_and_rhs_bytes.sol
#	test/libsolidity/smtCheckerTests/external_calls/call_with_value_1.sol
#	test/libsolidity/smtCheckerTests/external_calls/call_with_value_2.sol
#	test/libsolidity/smtCheckerTests/external_calls/external_call_from_constructor_3.sol
#	test/libsolidity/smtCheckerTests/external_calls/external_call_this_with_value_1.sol
#	test/libsolidity/smtCheckerTests/external_calls/external_call_with_value_3.sol
#	test/libsolidity/smtCheckerTests/external_calls/external_hash_known_code_state_reentrancy_2.sol
#	test/libsolidity/smtCheckerTests/external_calls/external_hash_known_code_state_reentrancy_indirect.sol
#	test/libsolidity/smtCheckerTests/external_calls/external_reentrancy_1.sol
#	test/libsolidity/smtCheckerTests/external_calls/external_reentrancy_2.sol
#	test/libsolidity/smtCheckerTests/function_selector/homer.sol
#	test/libsolidity/smtCheckerTests/functions/functions_storage_var_1_fail.sol
#	test/libsolidity/smtCheckerTests/imports/import_as_module_2.sol
#	test/libsolidity/smtCheckerTests/inheritance/receive_fallback.sol
#	test/libsolidity/smtCheckerTests/modifiers/modifier_inside_branch_assignment.sol
#	test/libsolidity/smtCheckerTests/operators/compound_assignment_division_3.sol
#	test/libsolidity/smtCheckerTests/operators/compound_bitwise_string_literal_3.sol
#	test/libsolidity/smtCheckerTests/out_of_bounds/array_1.sol
#	test/libsolidity/smtCheckerTests/overflow/signed_guard_sub_overflow.sol
#	test/libsolidity/smtCheckerTests/overflow/simple_overflow.sol
#	test/libsolidity/smtCheckerTests/special/block_vars_chc_internal.sol
#	test/libsolidity/smtCheckerTests/special/tx_vars_reentrancy_1.sol
#	test/libsolidity/smtCheckerTests/try_catch/try_public_var_mapping.sol
#	test/libsolidity/smtCheckerTests/typecast/bytes_to_fixed_bytes_1.sol
#	test/libsolidity/smtCheckerTests/typecast/string_to_bytes_push_1.sol
#	test/libsolidity/smtCheckerTests/types/array_branch_1d.sol
#	test/libsolidity/util/TestFileParser.cpp
#	test/libyul/ObjectParser.cpp
#	test/libyul/Parser.cpp
#	test/libyul/yulOptimizerTests/expressionSimplifier/side_effects_in_for_condition.yul
#	test/lsp.py
#	test/scripts/test_externalTests_benchmark_downloader.py
#	test/solc/Common.cpp
#	test/tools/ossfuzz/AbiV2IsabelleFuzzer.cpp
#	test/tools/ossfuzz/SolidityEvmoneInterface.cpp
#	test/tools/ossfuzz/SolidityEvmoneInterface.h
#	test/tools/ossfuzz/abiV2Proto.proto
#	test/tools/ossfuzz/abiV2ProtoFuzzer.cpp
#	test/tools/ossfuzz/protoToAbiV2.cpp
#	test/tools/ossfuzz/protoToAbiV2.h
#	test/tools/ossfuzz/solProtoFuzzer.cpp
#	test/yulPhaser/FitnessMetrics.cpp
#	test/yulPhaser/ProgramCache.cpp
#	test/yulPhaser/TestHelpers.cpp
#	tools/yulPhaser/Chromosome.cpp
#	tools/yulPhaser/GeneticAlgorithms.cpp
#	tools/yulPhaser/Mutations.cpp
#	tools/yulPhaser/PairSelections.h
#	tools/yulPhaser/Phaser.cpp
#	tools/yulPhaser/Population.cpp
#	tools/yulPhaser/Program.cpp
#	tools/yulPhaser/Selections.h
@r0qs r0qs added the sync-pr label Apr 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet