diff --git a/.gitlab/ci/doc.yml b/.gitlab/ci/doc.yml index 05131fdb571675425c5d40e0b35396336d117715..9eb755a30db0002360c78a4da6ae0669cf9c79fc 100644 --- a/.gitlab/ci/doc.yml +++ b/.gitlab/ci/doc.yml @@ -26,18 +26,15 @@ documentation:linkcheck: extends: - .default_settings_template - .image_template__runtime_build_test_dependencies_template - - .rules_template__development_manual - stage: manual - needs: - - job: documentation:build_all - artifacts: true + - .rules_template__development_documentation + stage: doc + needs: [] before_script: - . ./scripts/version.sh - . $HOME/.venv/bin/activate script: - make -C docs redirectcheck - make -C docs linkcheck - - make -C docs sanitycheck allow_failure: true # here we use this hack to publish the tezos documentation on diff --git a/docs/Makefile b/docs/Makefile index f7feac494d238ebf44d0ff4a757ef3190297dac4..9bf4677f1900a263367bcf4d87c0ebaca2fc3ed7 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -13,7 +13,8 @@ P2PDOCEXE = $(TOPBUILDDIR)/docs/$(DOCGENDIR)/p2p_doc.exe RPCDOCEXE = $(TOPBUILDDIR)/docs/$(DOCGENDIR)/rpc_doc.exe ERRDOCEXE = $(TOPBUILDDIR)/docs/$(DOCERRORDIR)/error_doc.exe -PROTOCOLS = ithaca jakarta alpha +NAMED_PROTOS = ithaca jakarta +PROTOCOLS = $(NAMED_PROTOS) alpha # The following variables names are lowercase, so their names can be computed # from the names of the corresponding protocol directories @@ -82,11 +83,11 @@ odoc-lite: main docexes @mkdir -p _build/api @cp -r $(TMPDOCDIR)/_build/default/_doc _build/api/odoc -linkcheck: - $(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" +linkcheck: html + @$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) .PHONY: redirectcheck -redirectcheck: +redirectcheck: html @cd $$(pwd)/.. ; ./scripts/lint.sh --check-redirects # xrefs should be checked: @@ -110,13 +111,6 @@ scriptsindoccheck: scripts/test_doc_scripts.sh compile-sources-buster #scripts/test_doc_scripts.sh use-docker # returns 1 (and eats alot of disk) -sanitycheck: - @if grep -Rq alpha 0*; then \ - echo "'alpha' occurs in the docs for released protocols:"; \ - grep -R alpha 0*; \ - exit 1; \ - fi - # build dune targets together to avoid concurrent dunes docexes: main cd .. && dune build docs/$(DOCERRORDIR)/error_doc.exe docs/$(DOCGENDIR)/rpc_doc.exe docs/$(DOCGENDIR)/p2p_doc.exe diff --git a/docs/alpha/consensus.rst b/docs/alpha/consensus.rst index 6d2854b1449b7035210154467906768483d850fa..2c93683262d8d3b6f8d9c57dc970b674938d266b 100644 --- a/docs/alpha/consensus.rst +++ b/docs/alpha/consensus.rst @@ -8,7 +8,7 @@ History ------- Before Tenderbake, there was -`Emmy* `_, +`Emmy* `_, a Nakamoto-style consensus consisting of a series of improvements of the one in the `Tezos whitepaper `_. @@ -20,7 +20,7 @@ with a probability that increases rapidly with fork length. `Tenderbake `_ instead, like any classic BFT-style consensus algorithm (such as -`PBFT `_ or +`PBFT `_ or `Tendermint `_), offers *deterministic* finality: a block that has just been appended to the chain of some node is known to be final once it has two additional blocks on top of it, regardless of @@ -36,7 +36,7 @@ for blockchains. Tenderbake adapts Tendermint to the Tezos blockchain, but the adjustments required are -`substantive `_: +`substantive `_: * Tenderbake is tailored to match the Tezos architecture by using only communication primitives and network assumptions which Tezos supports. @@ -47,7 +47,7 @@ required are The design of Tenderbake and its rationale are described at length in the `technical report `_ and in a `Nomadic Labs's blog -post `_. Here we +post `_. Here we only provide a user/developer perspective. .. _tb_validator_alpha: @@ -88,7 +88,7 @@ Schematically, a round consists in the following steps: .. _quorum_alpha: Unlike Emmy*, Tenderbake has `two types of -votes `_: +votes `_: before endorsing a block ``b``, a validator preendorses ``b``. Furthermore, to be able to endorse, a validator must have observed a preendorsement *quorum*, that is a set of preendorsements from validators having at least ``CONSENSUS_THRESHOLD`` validator slots. Similarly, to be able to decide, a validator must have observed an endorsement quorum, that is, a set of endorsements from validators having at least ``CONSENSUS_THRESHOLD`` validator slots. The diff --git a/docs/alpha/plugins.rst b/docs/alpha/plugins.rst index f888a7071561eec8d22104e0d31a16cb7af946a1..a1e0081ec0bb5391b60d1e587fdaad6706be08a3 100644 --- a/docs/alpha/plugins.rst +++ b/docs/alpha/plugins.rst @@ -50,7 +50,7 @@ the filters of the previous protocol. Notice that prevalidator filters are not mandatory, their absence does not break the Tezos blockchain protocol. The interface of the prevalidator plugin is described at the `mempool plugin API -`__ +`__ The different kinds of prevalidator filters are described below. diff --git a/docs/alpha/sapling.rst b/docs/alpha/sapling.rst index a7e2bf5cffb65c18c49b03002bc24eadf819781a..172417808363ceb4d0ace1adec324d7da78d9bf6 100644 --- a/docs/alpha/sapling.rst +++ b/docs/alpha/sapling.rst @@ -8,7 +8,7 @@ tokens in a decentralised environment. It was designed and implemented by the Electric Coin Company as the last iteration over a series of previous protocols and academic works starting with the `Zerocoin seminal -paper `_. +paper `_. The reference implementation of Sapling, `librustzcash `_, was diff --git a/docs/alpha/timelock.rst b/docs/alpha/timelock.rst index 9fc225ee4c5d0e1f4439dcb1416621cae5817fa9..f756fe77047c671ded851054b17bc710702ab5e1 100644 --- a/docs/alpha/timelock.rst +++ b/docs/alpha/timelock.rst @@ -134,5 +134,5 @@ allows a user to create chests and chest keys to interact with a smart contract. Example ------- -The raffle contract on Open Tezos `here `__ +The Raffle contract on Open Tezos (look for "raffle contract" using the search engine on ``https://opentezos.com/``) gives a concrete example of using time-lock. diff --git a/docs/developer/contributing.rst b/docs/developer/contributing.rst index e91992ebddafca7adb9feb10be4cad2bc7f0dbac..e8da5bc5d7e3a745d33e64d0b32c2f8451d0fcf5 100644 --- a/docs/developer/contributing.rst +++ b/docs/developer/contributing.rst @@ -572,7 +572,7 @@ painful for everybody. The reviewer is your ally, not your enemy. - Testing: Are the tests thoughtful? Do they cover the failure conditions? Are they easy to read? How fragile are they? How big are the tests? Are they slow? -- Are your commit messages meaningful? (see https://chris.beams.io/posts/git-commit/) +- Are your commit messages meaningful? (see https://cbea.ms/git-commit/) Review your own code before calling for a peer review from a colleague. diff --git a/docs/developer/gadt.rst b/docs/developer/gadt.rst index f5b968263844918bf2970315f8238192da77daf5..3d1b4ebee7e92961e6933cbcbd18c1c71d58236e 100644 --- a/docs/developer/gadt.rst +++ b/docs/developer/gadt.rst @@ -144,6 +144,6 @@ in :src:`src/proto_alpha/lib_protocol/script_ir_translator.ml` in function the same type or ``None`` if that's not the case. -.. _Algebraic Data Types: https://ocaml.org/learn/tutorials/data_types_and_matching.html +.. _Algebraic Data Types: https://ocaml.org/docs/data-types .. _Generalized Algebraic Data Types: https://ocaml.org/manual/gadts.html .. _A simple expression evaluator: https://blog.mads-hartmann.com/ocaml/2015/01/05/gadt-ocaml.html diff --git a/docs/developer/snoop.rst b/docs/developer/snoop.rst index 9ed9168f64b31bda3b125a29174cebfc1899dfc3..edbb15c4a83a9a4d9a04e19e6372a7d4b7f977e5 100644 --- a/docs/developer/snoop.rst +++ b/docs/developer/snoop.rst @@ -7,7 +7,7 @@ help you do that. This tool allows to benchmark any given piece of OCaml code and use these measures to fit cost models predictive of execution time. It is in particular used to derive the functions in the -`Michelson gas cost API `_, +`Michelson gas cost API `_, computing the gas costs in the Tezos protocol. .. toctree:: diff --git a/docs/developer/snoop_arch.rst b/docs/developer/snoop_arch.rst index 27b3bbb3323173f7a745de42a98f6a3b8e7a273e..056622cdce1c82cadf6e0dca77c5def2d772cd0e 100644 --- a/docs/developer/snoop_arch.rst +++ b/docs/developer/snoop_arch.rst @@ -221,7 +221,7 @@ variables is to stand in for variables to be inferred during the inference process (corresponding to :math:`\theta_i` in the previous section). The language is defined in tagless final style. If this does not ring a bell, we **strongly** recommend you take a look at -http://okmij.org/ftp/tagless-final/index.html in order to make sense of the +https://okmij.org/ftp/tagless-final/index.html in order to make sense of the rest of this section. The syntax is specified by the ``Costlang.S`` module type: diff --git a/docs/include/rpc_introduction.rst.inc b/docs/include/rpc_introduction.rst.inc index badc9de669553d57d96b54a0f74ecdb0ba6d1e4d..1c9bc2a0cdb9b61f6b8dbf13782b72a9754aa4ed 100644 --- a/docs/include/rpc_introduction.rst.inc +++ b/docs/include/rpc_introduction.rst.inc @@ -1,7 +1,18 @@ +This page describes the RPCs specific to a particular version of the Tezos protocol (specified below). + +.. note:: + + They are all served under the prefix ``/chains//blocks//``. + To make the RPC reference more readable, this prefix is not repeated every time below, but instead shortened as ``../``. + RPCs - Index ************ +Note that the RPCs served under a given prefix can also be listed using the client, e.g.:: + + tezos-client rpc list /chains/main/blocks/head/context/constants + Shell ===== -The protocol-independent RPCs are described :doc:`here <../shell/rpc>`. +The protocol-independent RPCs are described :doc:`in this other page <../shell/rpc>`. diff --git a/docs/index.rst b/docs/index.rst index d68b66bb4f56f8f4d339eb4773af0561f33fb3da..b5d45bb82895303011256259ac622b1dfc378a10 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -60,7 +60,8 @@ The Community - A few community-run websites collect useful Tezos links: - https://www.tezos.help - - https://tezos.rocks + - https://tezoscommons.org/ + - https://tqtezos.com/ - More resources can be found in the :doc:`introduction/support` page. @@ -87,7 +88,7 @@ Test Networks There are several test networks for the Tezos blockchain with a faucet to obtain free tez (see :ref:`faucet`). -It is the reference network for developers wanting to test their +These networks are intended for developers wanting to test their software before going to beta and for users who want to familiarize themselves with Tezos before using their real tez. diff --git a/docs/introduction/compile-sources.sh b/docs/introduction/compile-sources.sh index 8d2b1b74f24497d3cde395de057410cf528d6b89..d1745e125f51306bab2a08961d4f8214713e808f 100755 --- a/docs/introduction/compile-sources.sh +++ b/docs/introduction/compile-sources.sh @@ -35,7 +35,7 @@ sudo apt-get install -y sudo sudo apt-get install -y cargo # NV: to avoid error on compiling rust-conf export OPAMYES=true # [install packages] -sudo apt install -y rsync git m4 build-essential patch unzip wget pkg-config libgmp-dev libev-dev libhidapi-dev opam jq zlib1g-dev bc autoconf +sudo apt-get install -y rsync git m4 build-essential patch unzip wget pkg-config libgmp-dev libev-dev libhidapi-dev opam jq zlib1g-dev bc autoconf # [install rust] wget https://sh.rustup.rs/rustup-init.sh chmod +x rustup-init.sh diff --git a/docs/introduction/howtouse.rst b/docs/introduction/howtouse.rst index c9d41576c7f58e4ebdcb3a382bb83e160c90fdca..4a75344cd592943719643014e9c2f5e70510505b 100644 --- a/docs/introduction/howtouse.rst +++ b/docs/introduction/howtouse.rst @@ -136,7 +136,7 @@ Note that this is merely a network identity and it is not related in any way to a Tezos address on the blockchain. If you wish to run your node on a test network, now is also a good time -to configure your node (see :ref:`multinetwork`). +to configure your node (see :ref:`builtin_networks`). Node Synchronization ~~~~~~~~~~~~~~~~~~~~ @@ -232,7 +232,7 @@ Putting together all the above instructions, you may want to run a node as follo # Configure the node for running on : tezos-node config init --data-dir ~/.tezos-node- --network # Import the snapshot into the node data directory: - tezos-node snapshot --data-dir ~/.tezos-node- import --block + tezos-node snapshot import --data-dir ~/.tezos-node- --block # Run the node: tezos-node run --data-dir ~/.tezos-node- --rpc-addr 127.0.0.1 @@ -262,14 +262,14 @@ protocol run by the node. For instance, ``get timestamp`` isn't available when the node runs the genesis protocol, which may happen for a few minutes when launching a node for the first time. -.. _faucet: +.. _using_faucet: Get Free Tez ~~~~~~~~~~~~ To test the networks and help users get familiar with the system, on -:doc:`test networks` you can obtain free tez from a -`faucet `__. +:doc:`test networks` you can obtain free tez from +:ref:`a faucet `. This will provide a faucet account in the form of a JSON file ``tz1__xxxxxxxxx__.json``, that can be activated with the following diff --git a/docs/introduction/test_networks.rst b/docs/introduction/test_networks.rst index f903bdb3ff34fa63d1c5ecaa2bbcb62314365405..0d10a17239de78173d8b3d8e0c5a02a981174d24 100644 --- a/docs/introduction/test_networks.rst +++ b/docs/introduction/test_networks.rst @@ -23,8 +23,10 @@ the new protocol. So every time a new protocol is proposed on Mainnet, a new test network is spawned. This also makes synchronization much faster than with a long-lived network. -Get Free Funds -============== +.. _faucet: + +Faucets +======= Test networks have a list of built-in accounts with some funds. You can obtain the key to these accounts from a faucet to claim the funds. @@ -32,6 +34,8 @@ Faucets can be accessed from https://teztnets.xyz/. Each of the test network listed there, including the active test networks described below, have independent faucets. +See :ref:`using_faucet` for detailed instructions on using a faucet. + Jakartanet ========== diff --git a/docs/ithaca/consensus.rst b/docs/ithaca/consensus.rst index 574bc84624fa50750835d1b34fd1a15831e6f437..a13883ed9901f332b5d145ab5227a9baa23d5d76 100644 --- a/docs/ithaca/consensus.rst +++ b/docs/ithaca/consensus.rst @@ -8,7 +8,7 @@ History ------- Before Tenderbake, there was -`Emmy* `_, +`Emmy* `_, a Nakamoto-style consensus consisting of a series of improvements of the one in the `Tezos whitepaper `_. @@ -20,7 +20,7 @@ with a probability that increases rapidly with fork length. `Tenderbake `_ instead, like any classic BFT-style consensus algorithm (such as -`PBFT `_ or +`PBFT `_ or `Tendermint `_), offers *deterministic* finality: a block that has just been appended to the chain of some node is known to be final once it has two additional blocks on top of it, regardless of @@ -36,7 +36,7 @@ for blockchains. Tenderbake adapts Tendermint to the Tezos blockchain, but the adjustments required are -`substantive `_: +`substantive `_: * Tenderbake is tailored to match the Tezos architecture by using only communication primitives and network assumptions which Tezos supports. @@ -47,7 +47,7 @@ required are The design of Tenderbake and its rationale are described at length in the `technical report `_ and in a `Nomadic Labs's blog -post `_. Here we +post `_. Here we only provide a user/developer perspective. .. _tb_validator: @@ -92,7 +92,7 @@ Schematically, a round consists in the following steps: .. _quorum_ithaca: Unlike Emmy*, Tenderbake has `two types of -votes `_: +votes `_: before endorsing a block ``b``, a validator preendorses ``b``. Furthermore, to be able to endorse, a validator must have observed a preendorsement *quorum*, that is a set of preendorsements from validators having at least ``CONSENSUS_THRESHOLD`` validator slots. Similarly, to be able to decide, a validator must have observed an endorsement quorum, that is, a set of endorsements from validators having at least ``CONSENSUS_THRESHOLD`` validator slots. The diff --git a/docs/ithaca/plugins.rst b/docs/ithaca/plugins.rst index fc0857beed469e1447bda7e658eadb9e76ce6bc6..a86f15d6b18cf55ac485dfcbef84aeabe835d0fd 100644 --- a/docs/ithaca/plugins.rst +++ b/docs/ithaca/plugins.rst @@ -51,7 +51,7 @@ the filters of the previous protocol. Notice that prevalidator filters are not mandatory, their absence does not break the Tezos blockchain protocol. The interface of the prevalidator plugin is described at the `mempool plugin API -`__ +`__ The different kinds of prevalidator filters are described below. diff --git a/docs/ithaca/sapling.rst b/docs/ithaca/sapling.rst index c4411d7e730169ebe64bd0b93093bca35dd56581..780a030ed3e6eb2607081fc23756cc1841f49103 100644 --- a/docs/ithaca/sapling.rst +++ b/docs/ithaca/sapling.rst @@ -16,7 +16,7 @@ tokens in a decentralised environment. It was designed and implemented by the Electric Coin Company as the last iteration over a series of previous protocols and academic works starting with the `Zerocoin seminal -paper `_. +paper `_. The reference implementation of Sapling, `librustzcash `_, was diff --git a/docs/ithaca/timelock.rst b/docs/ithaca/timelock.rst index 9fc225ee4c5d0e1f4439dcb1416621cae5817fa9..f756fe77047c671ded851054b17bc710702ab5e1 100644 --- a/docs/ithaca/timelock.rst +++ b/docs/ithaca/timelock.rst @@ -134,5 +134,5 @@ allows a user to create chests and chest keys to interact with a smart contract. Example ------- -The raffle contract on Open Tezos `here `__ +The Raffle contract on Open Tezos (look for "raffle contract" using the search engine on ``https://opentezos.com/``) gives a concrete example of using time-lock. diff --git a/docs/jakarta/consensus.rst b/docs/jakarta/consensus.rst index 336c3ca3c35c489bb40f37aa35a3b704f1e209d2..72358a9366c564cb86539bcbf19c6b0c3670873f 100644 --- a/docs/jakarta/consensus.rst +++ b/docs/jakarta/consensus.rst @@ -8,7 +8,7 @@ History ------- Before Tenderbake, there was -`Emmy* `_, +`Emmy* `_, a Nakamoto-style consensus consisting of a series of improvements of the one in the `Tezos whitepaper `_. @@ -20,7 +20,7 @@ with a probability that increases rapidly with fork length. `Tenderbake `_ instead, like any classic BFT-style consensus algorithm (such as -`PBFT `_ or +`PBFT `_ or `Tendermint `_), offers *deterministic* finality: a block that has just been appended to the chain of some node is known to be final once it has two additional blocks on top of it, regardless of @@ -36,7 +36,7 @@ for blockchains. Tenderbake adapts Tendermint to the Tezos blockchain, but the adjustments required are -`substantive `_: +`substantive `_: * Tenderbake is tailored to match the Tezos architecture by using only communication primitives and network assumptions which Tezos supports. @@ -47,7 +47,7 @@ required are The design of Tenderbake and its rationale are described at length in the `technical report `_ and in a `Nomadic Labs's blog -post `_. Here we +post `_. Here we only provide a user/developer perspective. .. _tb_validator_jakarta: @@ -88,7 +88,7 @@ Schematically, a round consists in the following steps: .. _quorum_jakarta: Unlike Emmy*, Tenderbake has `two types of -votes `_: +votes `_: before endorsing a block ``b``, a validator preendorses ``b``. Furthermore, to be able to endorse, a validator must have observed a preendorsement *quorum*, that is a set of preendorsements from validators having at least ``CONSENSUS_THRESHOLD`` validator slots. Similarly, to be able to decide, a validator must have observed an endorsement quorum, that is, a set of endorsements from validators having at least ``CONSENSUS_THRESHOLD`` validator slots. The diff --git a/docs/jakarta/plugins.rst b/docs/jakarta/plugins.rst index 73450a387b425af1d9499a783034e44d5d3975a2..0687bdc5486e4b860d421d0ace291dc7475827af 100644 --- a/docs/jakarta/plugins.rst +++ b/docs/jakarta/plugins.rst @@ -50,7 +50,7 @@ the filters of the previous protocol. Notice that prevalidator filters are not mandatory, their absence does not break the Tezos blockchain protocol. The interface of the prevalidator plugin is described at the `mempool plugin API -`__ +`__ The different kinds of prevalidator filters are described below. diff --git a/docs/jakarta/sapling.rst b/docs/jakarta/sapling.rst index 67e80148142ee89bd611a3a98dc1d0b28faddd6e..d69cd3e17c72ac5a97c1646690eed9f896aa41e8 100644 --- a/docs/jakarta/sapling.rst +++ b/docs/jakarta/sapling.rst @@ -8,7 +8,7 @@ tokens in a decentralised environment. It was designed and implemented by the Electric Coin Company as the last iteration over a series of previous protocols and academic works starting with the `Zerocoin seminal -paper `_. +paper `_. The reference implementation of Sapling, `librustzcash `_, was diff --git a/docs/jakarta/timelock.rst b/docs/jakarta/timelock.rst index 9fc225ee4c5d0e1f4439dcb1416621cae5817fa9..f756fe77047c671ded851054b17bc710702ab5e1 100644 --- a/docs/jakarta/timelock.rst +++ b/docs/jakarta/timelock.rst @@ -134,5 +134,5 @@ allows a user to create chests and chest keys to interact with a smart contract. Example ------- -The raffle contract on Open Tezos `here `__ +The Raffle contract on Open Tezos (look for "raffle contract" using the search engine on ``https://opentezos.com/``) gives a concrete example of using time-lock. diff --git a/docs/protocols/005_babylon.rst b/docs/protocols/005_babylon.rst index ca2fc48f8129e55b66cdb7713f9a80709c09f994..38c34c5bb8e1f6c690c441553bc59ef64ea3c192 100644 --- a/docs/protocols/005_babylon.rst +++ b/docs/protocols/005_babylon.rst @@ -38,9 +38,9 @@ In particular: than 0. Detailed information can be found in the blog -`announcement `_ +`announcement `_ and -`analysis. `_ +`analysis. `_ Merge requests `(MR58) @@ -57,7 +57,7 @@ Protocol 005 contains several improvements to the Michelson smart contract language. More details are provided later in the changelog and in the `Michelson update blog post. -`_ +`_ A summary of the main changes: diff --git a/docs/protocols/006_carthage.rst b/docs/protocols/006_carthage.rst index b42cacb8037a2bc61bf4a3d9051a1e2644b2821f..a9eb547f18e7e3d4e485154b7c628c1ac3fc8967 100644 --- a/docs/protocols/006_carthage.rst +++ b/docs/protocols/006_carthage.rst @@ -47,7 +47,7 @@ in order to provide more accurate results. The formula was further modified in order to make it more resistant to certain types of attacks. A full explanation can be found -`here `_. +`here `_. Accounts -------- diff --git a/docs/protocols/007_delphi.rst b/docs/protocols/007_delphi.rst index e8239cd13411e0856d4176c4496c957097916781..4280ffdf41bee48c474e3b8eb425faa20f136bcc 100644 --- a/docs/protocols/007_delphi.rst +++ b/docs/protocols/007_delphi.rst @@ -13,7 +13,7 @@ See details in :ref:`Test Networks` and instructions to join in :ref:`How to get Tezos`. The source code of this proposal is available in `this tar archive -`_ and its +`_ and its full hash is ``PsDELPH1Kxsxt8f9eWbxQeRxkjfbxoqM52jvs5Y5fBxWWh4ifpo``. **This protocol contains several breaking changes with respect to Carthage.** diff --git a/docs/protocols/012_ithaca.rst b/docs/protocols/012_ithaca.rst index c480d11c502318b74f2e91110d8971c0977891b8..7915f085cb27d382da6fee13af1c41c8df981908 100644 --- a/docs/protocols/012_ithaca.rst +++ b/docs/protocols/012_ithaca.rst @@ -174,4 +174,4 @@ Minor Changes Context entries located in ``/chains/main/blocks//context/raw/bytes/cycle//roll_snapshot`` are no longer accessible after Tenderbake. - As observed in issue `:gl:`#2764`, the RPC is buggy for cycle ``474``: the correct result for that cycle is index 16 (not 4). + As observed in issue :gl:`#2764`, the RPC is buggy for cycle ``474``: the correct result for that cycle is index 16 (not 4). diff --git a/docs/protocols/naming.rst b/docs/protocols/naming.rst index 0464492f3239f3cbfedf94c6f90bcab0a35ad15b..6b872db06802d88e181d0f2719efcc56cc6468f5 100644 --- a/docs/protocols/naming.rst +++ b/docs/protocols/naming.rst @@ -65,7 +65,7 @@ The current protocol status can be found at election pages such as: tzstats.com_ An interesting blog post on the history of the initial Tezos economic protocols is: `A quick history of past upgrades -`_. +`_. .. _tzstats.com: https://tzstats.com/election/head .. _tzkt.io: https://tzkt.io/governance/current/exploration diff --git a/docs/protocols/tenderbake.rst b/docs/protocols/tenderbake.rst index ef352650fd1e6c2f186ef892845142904516f871..66f42092440c70eecf8c1be89e3a9d80ab62831d 100644 --- a/docs/protocols/tenderbake.rst +++ b/docs/protocols/tenderbake.rst @@ -4,7 +4,7 @@ Tenderbake ========== This page contains a summary of the changes brought by the Tenderbake merge request (:gl:`!3738`). -Please refer to :doc:`the documentation<../alpha/consensus>` and to this `blog post `_ for an overview of the Tenderbake consensus algorithm and its motivation. +Please refer to :doc:`the documentation<../alpha/consensus>` and to this `blog post `_ for an overview of the Tenderbake consensus algorithm and its motivation. Protocol -------- diff --git a/docs/releases/version-7.rst b/docs/releases/version-7.rst index e4bae86369922a7049f14589b3d02d221883a519..587ffdff24903c03be6948924178bea5ef619156 100644 --- a/docs/releases/version-7.rst +++ b/docs/releases/version-7.rst @@ -68,7 +68,7 @@ Multinetwork Node The node can now be used with any network, including Mainnet (the default network) and test networks such as Carthagenet or even custom -ones. See the :ref:`multinetwork` documentation page for more information. +ones. See the :doc:`../user/multinetwork` documentation page for more information. Thanks to this, the same release can be used for all networks instead of having one branch per network. This allows to name this release diff --git a/docs/shell/rpc_introduction.rst.inc b/docs/shell/rpc_introduction.rst.inc index 32b382da830301a889f0612a058b66ff69dcc836..028da9384517512a36c785807a0da2bb0cad5f16 100644 --- a/docs/shell/rpc_introduction.rst.inc +++ b/docs/shell/rpc_introduction.rst.inc @@ -1,8 +1,13 @@ +This page describes the RPCs built into the Octez shell, which are independent from a particular version of the Tezos protocol. + RPCs - Index ************ +Note that the RPCs served under a given prefix can also be listed using the client, e.g.:: + + tezos-client rpc list /chains/main/levels + Protocol ======== -Some RPCs are specific to a particular version of the Tezos protocol. -Those of the protocol currently active on Mainnet are described :doc:`here <../active/rpc>`. +The RPCs implemented by the protocol currently active on Mainnet, served under the prefix ``/chains//blocks//``, are described :doc:`in this other page <../active/rpc>`. diff --git a/docs/user/mockup.rst b/docs/user/mockup.rst index a375bbf863333456fdf1a52f1b17d103f59e328a..d890dbe2f58fe4ac7a3ba2cf1e110722c1720315 100644 --- a/docs/user/mockup.rst +++ b/docs/user/mockup.rst @@ -429,6 +429,4 @@ A command is provided to do the same on the persistent mockup state: The protocol corresponding to the hash must know how to migrate from the current protocol. -This is mostly useful for protocol developers, but also eg for developers -wanting to check the robustness of their application against new features -or breaking changes to the protocol. +This is mostly useful for protocol developers, but also for other developers, e.g., wanting to check the robustness of their application with respect to protocol changes, including new features or breaking changes. diff --git a/docs/user/multinetwork.rst b/docs/user/multinetwork.rst index f089a114cc1d75962f9f451d0ce69972ba6f47a6..8b14c468877678162eedc4006e6337e70ded2efc 100644 --- a/docs/user/multinetwork.rst +++ b/docs/user/multinetwork.rst @@ -1,7 +1,5 @@ .. TODO tezos/tezos#2170: search shifted protocol name/number & adapt -.. _multinetwork: - Multinetwork Node ================= diff --git a/docs/user/node-configuration.rst b/docs/user/node-configuration.rst index 6c44f02ea30d18a8f8f9445c1619aa89fddb179b..418dc3ff7835b2ccee8478777a75bdf96f27c0f8 100644 --- a/docs/user/node-configuration.rst +++ b/docs/user/node-configuration.rst @@ -66,7 +66,7 @@ The easiest way to amend this default configuration is to use # If you want to restart from an empty cfg file: tezos-node config reset <…> -However, note that the ``network`` configuration parameter, needed to run the node on a network other than the default one (Mainnet), can only be defined when the configuration file is initialized (using ``init``), and cannot be updated later (using ``update``). See the instructions for :ref:`running the node in test networks `. +However, note that the ``network`` configuration parameter, needed to run the node on a network other than the default one (Mainnet), can only be defined when the configuration file is initialized (using ``init``), and cannot be updated later (using ``update``). See the instructions for :doc:`running the node in test networks <./multinetwork>`. For example, the following script initializes and fills a configuration file using several command-line options: diff --git a/src/lib_store/snapshots.ml b/src/lib_store/snapshots.ml index ecdc1fdffe7d15b525b17e2430ef53fa0927f61c..999cee8be01e629c5e41b6382c542bc375185ccd 100644 --- a/src/lib_store/snapshots.ml +++ b/src/lib_store/snapshots.ml @@ -3752,7 +3752,7 @@ module Make_snapshot_importer (Importer : IMPORTER) : Snapshot_importer = struct Animation.display_progress ~every:100 ~pp_print_step:(fun fmt i -> - Format.fprintf fmt "Storing floating blocks: %d blocks wrote" i) + Format.fprintf fmt "Storing floating blocks: %d blocks written" i) ~progress_display_mode (fun notify -> Store.Unsafe.restore_from_snapshot diff --git a/src/proto_alpha/lib_client/client_proto_fa12.ml b/src/proto_alpha/lib_client/client_proto_fa12.ml index b7ec6493502fb721aa65623bd34c2d66151ffafc..ee75bf5cc1c3d2c006314478d8f9aea4fe271693 100644 --- a/src/proto_alpha/lib_client/client_proto_fa12.ml +++ b/src/proto_alpha/lib_client/client_proto_fa12.ml @@ -95,7 +95,7 @@ let () = "An FA1.2 command has referenced a smart contract whose script does not \ implement at least one FA1.2 entrypoint, or with an incompatible type. \ See TZIP-7 \ - (https://gitlab.com/tzip/tzip/-/blob/master/proposals/tzip-7/tzip-7.md) \ + (https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-7/tzip-7.md) \ for documentation on FA1.2." ~pp:(fun ppf (name, ty) -> Format.fprintf @@ -203,7 +203,7 @@ let () = "An FA1.2 non-zero allowance change failed because the current allowance \ is non-zero. For more explanation on why such allowance change is \ unsafe, please look at TZIP-7 \ - (https://gitlab.com/tzip/tzip/-/blob/master/proposals/tzip-7/tzip-7.md#approve)." + (https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-7/tzip-7.md#approve)." ~pp:(fun ppf previous -> Format.fprintf ppf @@ -329,14 +329,14 @@ let t_contract ~loc (a, is_a) : type_eq_combinator = equivalence checking functions, and returns a Micheline node for the `view a b` type, and a function checking another node is syntactically equivalent. The view type is defined by - [TZIP4](https://gitlab.com/tzip/tzip/-/blob/master/proposals/tzip-4/tzip-4.md). + [TZIP4](https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-4/tzip-4.md). *) let t_view ~loc a b : type_eq_combinator = t_pair ~loc [a; t_contract ~loc b] (** * Actions *) (** Corresponds to - [TZIP7](https://gitlab.com/tzip/tzip/-/blob/master/proposals/tzip-7/tzip-7.md) + [TZIP7](https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-7/tzip-7.md) entrypoints. *) (** A callback from a view can be on a specific entrypoint of the diff --git a/src/proto_alpha/lib_plugin/RPC.ml b/src/proto_alpha/lib_plugin/RPC.ml index 03c8f89a1e060228cb8c52c898d4498805b033cf..a0d393f2da53e146247506dedfa730c106f4c77c 100644 --- a/src/proto_alpha/lib_plugin/RPC.ml +++ b/src/proto_alpha/lib_plugin/RPC.ml @@ -256,7 +256,7 @@ module Scripts = struct RPC_service.post_service ~description: "Simulate a call to a view following the TZIP-4 standard. See \ - https://gitlab.com/tzip/tzip/-/blob/master/proposals/tzip-4/tzip-4.md#view-entrypoints." + https://gitlab.com/tezos/tzip/-/blob/master/proposals/tzip-4/tzip-4.md#view-entrypoints." ~input:run_tzip4_view_encoding ~output:(obj1 (req "data" Script.expr_encoding)) ~query:RPC_query.empty diff --git a/src/proto_alpha/lib_protocol/contract_services.ml b/src/proto_alpha/lib_protocol/contract_services.ml index 451152673e8715624ebb77dda618f65e63ada733..79845b68c5ef79259be923ad0626600b0466b0c6 100644 --- a/src/proto_alpha/lib_protocol/contract_services.ml +++ b/src/proto_alpha/lib_protocol/contract_services.ml @@ -84,7 +84,7 @@ module S = struct let manager_key = RPC_service.get_service - ~description:"Access the manager of a contract." + ~description:"Access the manager of an implicit contract." ~query:RPC_query.empty ~output:(option Signature.Public_key.encoding) RPC_path.(custom_root /: Contract.rpc_arg / "manager_key")