diff --git a/docs/alpha/sapling.rst b/docs/alpha/sapling.rst index c7b5e1e7549ed65b3225de5896783b30403743f3..9b3847c39c2ef3dc8c4f42e5dd9409a47e27e325 100644 --- a/docs/alpha/sapling.rst +++ b/docs/alpha/sapling.rst @@ -12,7 +12,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 `__. Keys ~~~~ diff --git a/docs/alpha/staking.rst b/docs/alpha/staking.rst index 50baf482c31ac568e26734284ceebae2d645bf6d..b51af8ef2fb0865ca15a061873e881c7b205ca42 100644 --- a/docs/alpha/staking.rst +++ b/docs/alpha/staking.rst @@ -195,6 +195,8 @@ or more conveniently:: octez-client finalize unstake for +Note that starting with protocol S, not only the staker, but anyone can trigger ``finalize_unstake`` (in any case, the unfrozen funds still go to the staker). + In some circumstances, unstake and finalize can be done implicitly: any call to ``stake`` or ``unstake`` will implicitly finalize all currently finalizable pending unstake requests. Also, as we will see next, change of delegate triggers an diff --git a/docs/index.rst b/docs/index.rst index dcd9ea71453f4a93743a3d3768450a7cc08a5134..3b86ee005cd70bc76b0bb8727bdf613fbfa7fa77 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -157,7 +157,6 @@ You may also access this whole documentation as a single `text file ` - using a development environment which had been used to build Octez - versions up to v13.x, and also you have previously exported the - ``tezos`` directory to the ``$PATH`` environment variable, the - following stanza is necessary to avoid potential issues with opam - in the ``make build-deps`` step:: - - PATH=${PATH##"$HOME"/tezos/:} - - Otherwise, it is possible for ``make build-deps`` to fail with the - following (or a similar) error:: - - make: opam: Permission denied - Makefile:53: *** Unexpected opam version (found: , expected: 2.*). Stop. + If you rerun the procedure above in an already cloned repository, typically by restarting from ``git checkout $BRANCH`` after upgrading the sources to a new version of Octez, you should do a ``git fetch`` before, to ensure that the tags for the latest release are known to Git. Otherwise, the sources compile perfectly fine but Octez executables may report their version incorrectly (e.g. ``21.2+dev`` instead of ``22.0``). The following sections describe the individual steps above in more detail. diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index dc89a135c3280db650232642af193f676eee34bb..6ed19ab8625768fac76f876c2b71a48fea3a2b2f 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -32,9 +32,9 @@ There are several options for getting the binaries, depending on how you plan to sources. -These different options are described in the following sections. +These different options are described in the following sections, except the last one, described in its own page. -Some Octez binaries also require some parameter files to run. Only some of the packaged distributions include such parameter files. Therefore, depending on the type of installation and your user profile, you may have to install some extra parameter files separately. Their installation is currently described in section :doc:`howtobuild`, but those instructions may be used for other installation types: +Some Octez binaries also require certain parameter files to run. Only some of the packaged distributions include such parameter files. Therefore, depending on the type of installation and your user profile, you may have to install some extra parameter files separately. Their installation is described in page :doc:`howtobuild`, but those instructions may be used for other installation types: - :ref:`setup_zcash_params` - :ref:`setup_dal_crypto_params` @@ -272,12 +272,7 @@ automatically generated and published on `DockerHub way to run an always up-to-date ``octez-node``. From version 22.0 all Octez Docker images are signed using Cosign. -You can verify if the images are correctly signed using the Cosign utility, as explained below: - -.. toctree:: - :maxdepth: 2 - - cosign-verify +You can verify if the images are correctly signed, :doc:`using Cosign <./cosign-verify>`. You can use the Docker images either directly or using Docker compose files, as explained next. In both cases, you need to have `Docker `__ installed and started (`Docker Desktop `__ would suffice for the instructions below). @@ -629,4 +624,6 @@ Appendix .. toctree:: :maxdepth: 2 + howtobuild + cosign-verify get_troubleshooting diff --git a/docs/introduction/services.rst b/docs/introduction/services.rst index d1643155c938906814ac50960c7bab4a63786196..84199d613b3b125378c3f379f56afd023aa62ea8 100644 --- a/docs/introduction/services.rst +++ b/docs/introduction/services.rst @@ -170,6 +170,7 @@ Now that everything is in place, we can start the Octez baker. This service will automatically start all accusers and bakers for all protocols shipped with the package. It will also start a :doc:`DAL node <../shell/dal_node>` alongside the baker, which is the recommended setting for all bakers. +The DAL node is run in a default configuration, that is, in controller mode without any profile; you may edit file ``/etc/default/octez-dal-node`` or use commands such as ``sudo su tezos -c "octez-dal-node config ..."`` to set up another configuration, refer to page :doc:`../shell/dal_node`. The logs of the baker are available in ``/var/log/tezos/baker-.log``. diff --git a/docs/rio/sapling.rst b/docs/rio/sapling.rst index eefb966755316ce4d2549eaf9b8d815ddfb6be23..5ad405e3fbd39b20a3b88b7aca80c1ef1ed71022 100644 --- a/docs/rio/sapling.rst +++ b/docs/rio/sapling.rst @@ -12,7 +12,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 `__. Keys ~~~~ diff --git a/docs/s023/sapling.rst b/docs/s023/sapling.rst index 29ea24657649e07496717dc51209fd62e0775354..2f7b7c919c59a4b241738c0523e93f92139cc639 100644 --- a/docs/s023/sapling.rst +++ b/docs/s023/sapling.rst @@ -12,7 +12,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 `__. Keys ~~~~ diff --git a/docs/s023/staking.rst b/docs/s023/staking.rst index 956f616f7dce3347c6a9cc79bd62edf512f8f9d3..bf659557c3ae4d6960589e13359c90ea7b700dc8 100644 --- a/docs/s023/staking.rst +++ b/docs/s023/staking.rst @@ -195,6 +195,8 @@ or more conveniently:: octez-client finalize unstake for +Note that starting with protocol S, not only the staker, but anyone can trigger ``finalize_unstake`` (in any case, the unfrozen funds still go to the staker). + In some circumstances, unstake and finalize can be done implicitly: any call to ``stake`` or ``unstake`` will implicitly finalize all currently finalizable pending unstake requests. Also, as we will see next, change of delegate triggers an