From fd2c5c82e01610c7c5aa90b15948eec75617bfdb Mon Sep 17 00:00:00 2001 From: Tom Knudsen Date: Mon, 9 May 2022 05:14:43 +0000 Subject: [PATCH 01/15] Store: doc: fix typo in output --- src/lib_store/snapshots.ml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib_store/snapshots.ml b/src/lib_store/snapshots.ml index ecdc1fdffe7d..999cee8be01e 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 -- GitLab From 8cef2976e96982a03aeadae0f42ef5039f869ef7 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 11 May 2022 16:37:01 +0200 Subject: [PATCH 02/15] doc: fix command for snapshot import in howtouse.rst --- docs/introduction/howtouse.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction/howtouse.rst b/docs/introduction/howtouse.rst index c9d41576c7f5..8062cd7a87b0 100644 --- a/docs/introduction/howtouse.rst +++ b/docs/introduction/howtouse.rst @@ -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 -- GitLab From daa9b82c95e85aa7dbbd397132148dee49c40fe2 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 23 May 2022 15:21:34 +0200 Subject: [PATCH 03/15] doc: fix address of faucets --- docs/introduction/howtouse.rst | 6 +++--- docs/introduction/test_networks.rst | 8 ++++++-- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/introduction/howtouse.rst b/docs/introduction/howtouse.rst index 8062cd7a87b0..52b02bec3d4f 100644 --- a/docs/introduction/howtouse.rst +++ b/docs/introduction/howtouse.rst @@ -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 f903bdb3ff34..0d10a17239de 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 ========== -- GitLab From 5e23a8322723718a9e5ef9547d1a33498e955a88 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 31 May 2022 16:03:33 +0200 Subject: [PATCH 04/15] doc: explain RPC prefixes at the beginning of the RPC reference pages --- docs/include/rpc_introduction.rst.inc | 13 ++++++++++++- docs/shell/rpc_introduction.rst.inc | 9 +++++++-- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/include/rpc_introduction.rst.inc b/docs/include/rpc_introduction.rst.inc index badc9de66955..1c9bc2a0cdb9 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/shell/rpc_introduction.rst.inc b/docs/shell/rpc_introduction.rst.inc index 32b382da8303..028da9384517 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>`. -- GitLab From a6298e82f61973cabd642a06146d8ee9c21bedf5 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 1 Jun 2022 12:16:38 +0200 Subject: [PATCH 05/15] doc: mention that manager_key rpc is only for implicit contracts (#2876) --- src/proto_alpha/lib_protocol/contract_services.ml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/proto_alpha/lib_protocol/contract_services.ml b/src/proto_alpha/lib_protocol/contract_services.ml index 451152673e87..79845b68c5ef 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") -- GitLab From cb31938f60de15a9092518014bc6b09a53fe1d0d Mon Sep 17 00:00:00 2001 From: Eugen Zalinescu Date: Wed, 1 Jun 2022 13:31:04 +0200 Subject: [PATCH 06/15] docs: fix typo --- docs/protocols/012_ithaca.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocols/012_ithaca.rst b/docs/protocols/012_ithaca.rst index c480d11c5023..7915f085cb27 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). -- GitLab From 3fca7285494989bd4c81c39312edd943aecdd6fa Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 3 Jun 2022 18:38:44 +0200 Subject: [PATCH 07/15] doc: fix intro to test networks in index.rst --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index d68b66bb4f56..b5a9d06fb759 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -87,7 +87,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. -- GitLab From 35cc3c8f05283dff5d35e088612a151efad6aea9 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 3 Jun 2022 11:16:43 +0200 Subject: [PATCH 08/15] doc: fix broken links reported by make linkcheck --- docs/alpha/consensus.rst | 10 +++++----- docs/alpha/plugins.rst | 2 +- docs/alpha/sapling.rst | 2 +- docs/alpha/timelock.rst | 2 +- docs/developer/contributing.rst | 2 +- docs/developer/gadt.rst | 2 +- docs/developer/snoop.rst | 2 +- docs/developer/snoop_arch.rst | 2 +- docs/index.rst | 3 ++- docs/ithaca/consensus.rst | 10 +++++----- docs/ithaca/plugins.rst | 2 +- docs/ithaca/sapling.rst | 2 +- docs/ithaca/timelock.rst | 2 +- docs/jakarta/consensus.rst | 10 +++++----- docs/jakarta/plugins.rst | 2 +- docs/jakarta/sapling.rst | 2 +- docs/jakarta/timelock.rst | 2 +- docs/protocols/005_babylon.rst | 6 +++--- docs/protocols/006_carthage.rst | 2 +- docs/protocols/007_delphi.rst | 2 +- docs/protocols/naming.rst | 2 +- docs/protocols/tenderbake.rst | 2 +- src/proto_alpha/lib_client/client_proto_fa12.ml | 8 ++++---- src/proto_alpha/lib_plugin/RPC.ml | 2 +- 24 files changed, 42 insertions(+), 41 deletions(-) diff --git a/docs/alpha/consensus.rst b/docs/alpha/consensus.rst index 6d2854b1449b..2c93683262d8 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 f888a7071561..a1e0081ec0bb 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 a7e2bf5cffb6..172417808363 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 9fc225ee4c5d..f756fe77047c 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 e91992ebddaf..e8da5bc5d7e3 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 f5b968263844..3d1b4ebee7e9 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 9ed9168f64b3..edbb15c4a83a 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 27b3bbb33231..056622cdce1c 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/index.rst b/docs/index.rst index b5a9d06fb759..b5d45bb82895 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. diff --git a/docs/ithaca/consensus.rst b/docs/ithaca/consensus.rst index 574bc84624fa..a13883ed9901 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 fc0857beed46..a86f15d6b18c 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 c4411d7e7301..780a030ed3e6 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 9fc225ee4c5d..f756fe77047c 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 336c3ca3c35c..72358a9366c5 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 73450a387b42..0687bdc5486e 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 67e80148142e..d69cd3e17c72 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 9fc225ee4c5d..f756fe77047c 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 ca2fc48f8129..38c34c5bb8e1 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 b42cacb8037a..a9eb547f18e7 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 e8239cd13411..4280ffdf41be 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/naming.rst b/docs/protocols/naming.rst index 0464492f3239..6b872db06802 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 ef352650fd1e..66f42092440c 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/src/proto_alpha/lib_client/client_proto_fa12.ml b/src/proto_alpha/lib_client/client_proto_fa12.ml index b7ec6493502f..ee75bf5cc1c3 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 03c8f89a1e06..a0d393f2da53 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 -- GitLab From 4fdda8867b956a4a952128f47fc19c2669c39837 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 3 Jun 2022 18:38:04 +0200 Subject: [PATCH 09/15] doc: replace apt by apt-get in compile-sources.sh (former is discouraged in scripts) --- docs/introduction/compile-sources.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction/compile-sources.sh b/docs/introduction/compile-sources.sh index 8d2b1b74f244..d1745e125f51 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 -- GitLab From 6363bf18b84ef9a5f3935f5737862fec0e089088 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 8 Jun 2022 11:22:55 +0200 Subject: [PATCH 10/15] add dependency of linkcheck and redirectcheck on html and enable parallelism --- docs/Makefile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index f7feac494d23..b22994f5b055 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -82,11 +82,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: -- GitLab From 4324962ed33afb072c2e286acfbee492ff156dac Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 8 Jun 2022 11:32:08 +0200 Subject: [PATCH 11/15] doc: fix CI job linkcheck and remove dependency to build_all --- .gitlab/ci/doc.yml | 5 +---- docs/Makefile | 8 +++++--- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/.gitlab/ci/doc.yml b/.gitlab/ci/doc.yml index 05131fdb5716..c0cd07a2ce76 100644 --- a/.gitlab/ci/doc.yml +++ b/.gitlab/ci/doc.yml @@ -28,16 +28,13 @@ documentation:linkcheck: - .image_template__runtime_build_test_dependencies_template - .rules_template__development_manual stage: manual - needs: - - job: documentation:build_all - artifacts: true + 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 b22994f5b055..376daa64af9b 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 @@ -111,9 +112,10 @@ scriptsindoccheck: #scripts/test_doc_scripts.sh use-docker # returns 1 (and eats alot of disk) sanitycheck: - @if grep -Rq alpha 0*; then \ + @make clean + @if grep -Rq alpha $(NAMED_PROTOS); then \ echo "'alpha' occurs in the docs for released protocols:"; \ - grep -R alpha 0*; \ + grep -R alpha $(NAMED_PROTOS); \ exit 1; \ fi -- GitLab From dee6ead36e2db243daf6174f3cc69ad4bdb68934 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 8 Jun 2022 17:09:03 +0200 Subject: [PATCH 12/15] doc: move CI job linkcheck to stage "doc" (hence, also in the scheduled pipeline) --- .gitlab/ci/doc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitlab/ci/doc.yml b/.gitlab/ci/doc.yml index c0cd07a2ce76..9eb755a30db0 100644 --- a/.gitlab/ci/doc.yml +++ b/.gitlab/ci/doc.yml @@ -26,8 +26,8 @@ documentation:linkcheck: extends: - .default_settings_template - .image_template__runtime_build_test_dependencies_template - - .rules_template__development_manual - stage: manual + - .rules_template__development_documentation + stage: doc needs: [] before_script: - . ./scripts/version.sh -- GitLab From 96ce2d608bd395cfad602d2bb96d8f163e9ee4d9 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 9 Jun 2022 11:46:50 +0200 Subject: [PATCH 13/15] doc: remove top label in multinetwork.rst --- docs/introduction/howtouse.rst | 2 +- docs/releases/version-7.rst | 2 +- docs/user/multinetwork.rst | 2 -- docs/user/node-configuration.rst | 2 +- 4 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/introduction/howtouse.rst b/docs/introduction/howtouse.rst index 52b02bec3d4f..4a75344cd592 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 ~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/releases/version-7.rst b/docs/releases/version-7.rst index e4bae8636992..587ffdff2490 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/user/multinetwork.rst b/docs/user/multinetwork.rst index f089a114cc1d..8b14c4688776 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 6c44f02ea30d..418dc3ff7835 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: -- GitLab From c88820b74f950f2397cb3ab31c605c49309f2bc8 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 9 Jun 2022 18:20:25 +0200 Subject: [PATCH 14/15] doc: rephrasing in mockup.rst --- docs/user/mockup.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/user/mockup.rst b/docs/user/mockup.rst index a375bbf86333..d890dbe2f58f 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. -- GitLab From 2dc1618640525f5e538b28996b32db8f22e069c0 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 13 Jun 2022 17:20:36 +0200 Subject: [PATCH 15/15] doc: remove makefile target sanity: --- docs/Makefile | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 376daa64af9b..9bf4677f1900 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -111,14 +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: - @make clean - @if grep -Rq alpha $(NAMED_PROTOS); then \ - echo "'alpha' occurs in the docs for released protocols:"; \ - grep -R alpha $(NAMED_PROTOS); \ - 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 -- GitLab