diff --git a/.gitlab/ci/test-doc-scripts.yml b/.gitlab/ci/test-doc-scripts.yml index 36931a5ea83dc893d00456d5420f4bf318f25648..a8995bd8184d5164914dcfefb1dd51ff53d61c29 100644 --- a/.gitlab/ci/test-doc-scripts.yml +++ b/.gitlab/ci/test-doc-scripts.yml @@ -20,14 +20,14 @@ install_bin_focal: script: - bash ./docs/introduction/install-bin-fedora.sh -install_bin_fedora_31: - image: fedora:31 - extends: .install_bin_fedora_template - install_bin_fedora_32: image: fedora:32 extends: .install_bin_fedora_template +install_bin_fedora_33: + image: fedora:33 + extends: .install_bin_fedora_template + .install_opam_ubuntu_template: extends: .base-test-doc-scripts-template script: diff --git a/docs/_redirects b/docs/_redirects index 56761a4a20173f305c15f8db8f1ebb7b2ba769d2..4b7bd016d0aac9331c45cee4ac111ff11ec1e875 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,5 +1,10 @@ /api/cli-commands.html /shell/cli-commands.html 302 /007/cli-commands.html /shell/cli-commands.html 302 +/007/rpc.html /shell/rpc.html 302 +/007/glossary.html /alpha/glossary.html 302 +/007/michelson.html /alpha/michelson.html 302 +/007/proof_of_stake.html /alpha/proof_of_stake.html 302 +/007/voting.html /alpha/voting.html 302 /api/rpc.html /008/rpc.html 302 /developer/sapling.html /008/sapling.html 302 /user/glossary.html /008/glossary.html 302 diff --git a/docs/developer/contributing.rst b/docs/developer/contributing.rst index a392060d744cf152fe6a86133b5d24c65b1f2f94..58e7d0e29d39129c739a2be4175806f2a8c7e458 100644 --- a/docs/developer/contributing.rst +++ b/docs/developer/contributing.rst @@ -296,9 +296,7 @@ In the special case where your MR adds a new Python, Rust, Javascript, or other dependency, additional steps must also be followed. * for Python, you can refer to the related section in the :ref:`python testing documentation `. -* the Rust dependencies are located in the GitLab repository `tezos-rust-libs -`_ and the instructions are listed -there. +* the Rust dependencies are located in the GitLab repository `tezos-rust-libs `_ and the instructions are listed there. For others, there is currently no dedicated guide. Do not hesitate to ask for help on the ``#devteam`` channel on the `tezos-dev` Slack. diff --git a/docs/developer/guidelines.rst b/docs/developer/guidelines.rst index 5fa4df31f8ee188cc3f003202a40fb9ffc567cd2..8ef30b8256b8b632246038d9735c651b6fce489c 100644 --- a/docs/developer/guidelines.rst +++ b/docs/developer/guidelines.rst @@ -58,24 +58,31 @@ Constants and struct fields: - Purpose and definition of this data. If the unit is a measurement of time, include it, e.g., TIMEOUT_MS for timeout in milliseconds. -Documenting interfaces ----------------------- +Documenting interfaces and implementations +------------------------------------------ At the granularity of OCaml files, it is essential to document the interface implemented by each file. +In many cases, it is useful to also document the implementation, but *separately* from the interface. Implementation (``.ml``) files: -- In the common case where there is a corresponding interface (``.mli``) file, - document the interface file instead, as detailed below. -- In the less common case where there is no corresponding interface (``.mli``) - file, document the exported elements directly in the implementation (``.ml``) - file. +- Document the interface: + + + In the common case where there is a corresponding interface (``.mli``) file, + document the interface file instead, as detailed below. + + In the less common case where there is no corresponding interface (``.mli``) + file, document the exported elements directly in the implementation + (``.ml``) file. + +- Document the implementation: For many non-trivial implementations, it is most useful to document the design principles, code structure, internal invariants, and so on. + Such information should be placed in a comment block at the top of the file. Interface (``.mli``) file comments: - One-line description - Brief description of the library, introducing the needed concepts -- Brief description of each module, type, function, data, as described for :ref:`comments in the code`. +- Brief description of each module, type, function, data, as described for :ref:`comments in the code` +- If applicable, external invariants (i.e., visible to the user). README files ------------ @@ -171,7 +178,7 @@ for additional options). Coding conventions ------------------ -+Other than the formatting rules above, there are currently no coding +Other than the formatting rules above, there are currently no coding conventions enforced in the codebase. However, Tezos developers should be aware of general `OCaml programming guidelines `_, which recommend formatting, naming conventions, diff --git a/docs/developer/python_testing_framework.rst b/docs/developer/python_testing_framework.rst index 2f6f55a7f3936037b5c61539007874e8094e8a47..378a0e9ad51252ff9f8e010475a5bf8f7cd1d8be 100644 --- a/docs/developer/python_testing_framework.rst +++ b/docs/developer/python_testing_framework.rst @@ -674,6 +674,7 @@ such as ``utils.check_contains_operations(client, [op_hash])`` instead of using blocking commands. .. _python_adding_new_dependencies: + Adding new dependencies ----------------------- diff --git a/docs/introduction/compile-sources.sh b/docs/introduction/compile-sources.sh index d861d9ef4cdffbe7a3dc235759d294ac2a755d0a..e45a43a8117485b5b891809cc9ebd403359bfb8a 100644 --- a/docs/introduction/compile-sources.sh +++ b/docs/introduction/compile-sources.sh @@ -30,3 +30,4 @@ source ./src/bin_client/bash-completion.sh export TEZOS_CLIENT_UNSAFE_DISABLE_DISCLAIMER=Y # [test executable] ./tezos-client +./tezos-node config --help diff --git a/docs/introduction/howtouse.rst b/docs/introduction/howtouse.rst index 79f4a99c3f2a96246cece6b64f5f9923b44cf970..e12f630571e25d553a51f2cb7786e3471df438b4 100644 --- a/docs/introduction/howtouse.rst +++ b/docs/introduction/howtouse.rst @@ -503,7 +503,7 @@ usage. Otherwise, you can force a low fee operation using the `--force-low-fee`, with the risk that no baker will include it. More test contracts can be found in directory -:src:`tests_python/contracts_007/`. +:src:`tests_python/contracts_alpha/`. Advanced documentation of the smart contract language is available :ref:`here`. diff --git a/docs/introduction/install-bin-fedora.sh b/docs/introduction/install-bin-fedora.sh index e64f1e78c932176dd97d1da4bbfca4b0cd2f83fc..888e880482b7bf47040c08428f5077956b476922 100644 --- a/docs/introduction/install-bin-fedora.sh +++ b/docs/introduction/install-bin-fedora.sh @@ -6,6 +6,6 @@ dnf install -y dnf-plugins-core dnf copr enable -y @Serokell/Tezos && dnf update -y dnf install -y tezos-client dnf install -y tezos-node -dnf install -y tezos-baker-007-PsDELPH1 -dnf install -y tezos-endorser-007-PsDELPH1 -dnf install -y tezos-accuser-007-PsDELPH1 +dnf install -y tezos-baker-008-PtEdo2Zk +dnf install -y tezos-endorser-008-PtEdo2Zk +dnf install -y tezos-accuser-008-PtEdo2Zk diff --git a/docs/introduction/install-bin-ubuntu.sh b/docs/introduction/install-bin-ubuntu.sh index 1bb3ebadfb6d577ef2c3f4eacb7f8299905db949..dd84bb0d45c4ce90941dc3ea2c752f57a515d03a 100644 --- a/docs/introduction/install-bin-ubuntu.sh +++ b/docs/introduction/install-bin-ubuntu.sh @@ -8,6 +8,6 @@ apt-get install -y software-properties-common can be: * use-docker * install-bin-bionic * install-bin-focal -* install-bin-fedora31 * install-bin-fedora32 +* install-bin-fedora33 * install-opam-scratch * install-opam-bionic * install-opam-focal @@ -49,12 +49,12 @@ case "$1" in "install-bin-focal" ) docker run --rm -i $UBUNTU_FOCAL <"$MYDIR"/install-bin-ubuntu.sh ;; - "install-bin-fedora31" ) - docker run --rm -i fedora:31 <"$MYDIR"/install-bin-fedora.sh - ;; "install-bin-fedora32" ) docker run --rm -i fedora:32 <"$MYDIR"/install-bin-fedora.sh ;; + "install-bin-fedora33" ) + docker run --rm -i fedora:33 <"$MYDIR"/install-bin-fedora.sh + ;; "install-opam-scratch" ) docker run --rm -i --privileged $UBUNTU_BIONIC <"$MYDIR"/install-opam-scratch.sh ;; diff --git a/docs/user/various.rst b/docs/user/various.rst index ab8fcd9a69ec8b495672b621096b7bdaef1bf306..b077872c65f436a6b011aedcb366320516fb1386 100644 --- a/docs/user/various.rst +++ b/docs/user/various.rst @@ -30,8 +30,9 @@ scripts without interacting with a Tezos node) by adding in your Note that the Michelson mode will be chosen automatically by Emacs for files with a ``.tz`` or ``.tez`` extension. -We can now open our favourite contract ``emacs -./src/bin_client/test/contracts/attic/id.tz`` and, when moving the cursor on +We can now open our favourite contract +:src:`./tests_python/contracts_alpha/attic/id.tz` in Emacs +and, when moving the cursor on a Michelson instruction, in the bottom of the windows Emacs should display the state of the stack before (left) and after (right) the application of the instruction. @@ -41,7 +42,7 @@ run it locally: :: - tezos-client run script ./src/bin_client/test/contracts/attic/id.tz \ + tezos-client run script ./tests_python/contracts_alpha/attic/id.tz \ on storage '"hello"' and input '"world"' .. _tezos-admin-client: diff --git a/src/lib_client_base_unix/client_config.ml b/src/lib_client_base_unix/client_config.ml index 68528b9610829a01ae20fc12f0a7ab6ab579ea22..2b593d27042bc9bd193679a16e22237acf2f11ef 100644 --- a/src/lib_client_base_unix/client_config.ml +++ b/src/lib_client_base_unix/client_config.ml @@ -368,13 +368,14 @@ let base_dir_arg () = ~placeholder:"path" ~doc: (Format.asprintf - "@[@[<2>client data directory@,\ + "@[@[<2>client data directory (absent: %s env)@,\ The directory where the Tezos client will store all its data.@,\ If absent, its value is the value of the %s@,\ environment variable. If %s is itself not specified,@,\ defaults to %s@]@]@." base_dir_env_name base_dir_env_name + base_dir_env_name default_base_dir) (string_parameter ())