From eea7f25bc75c1639a74ea4307e3b3c8d34e6a7cc Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 18 Jun 2025 16:20:36 +0200 Subject: [PATCH 1/6] doc: mention possible customizations of the DAL node in services.rst --- docs/introduction/services.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/introduction/services.rst b/docs/introduction/services.rst index d1643155c938..84199d613b3b 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``. -- GitLab From 37b924fc48d64469e4fa5585e8610a8022d889bc Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 18 Jun 2025 18:22:48 +0200 Subject: [PATCH 2/6] doc: recommend "git fetch" when recompiling sources --- docs/introduction/howtobuild.rst | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/docs/introduction/howtobuild.rst b/docs/introduction/howtobuild.rst index 0f4ac60a7a59..bec350b7bc9d 100644 --- a/docs/introduction/howtobuild.rst +++ b/docs/introduction/howtobuild.rst @@ -25,20 +25,7 @@ and then do: .. warning:: - If you are updating to :doc:`Octez v14<../releases/version-14>` - 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. -- GitLab From f5fbac8d24e2168d6e21898f2122f67c89134973 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 24 Jun 2025 11:20:19 +0200 Subject: [PATCH 3/6] doc: fix link to Sapling seminal paper --- docs/alpha/sapling.rst | 2 +- docs/rio/sapling.rst | 2 +- docs/s023/sapling.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/alpha/sapling.rst b/docs/alpha/sapling.rst index c7b5e1e7549e..9b3847c39c2e 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/rio/sapling.rst b/docs/rio/sapling.rst index eefb96675531..5ad405e3fbd3 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 29ea24657649..2f7b7c919c59 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 ~~~~ -- GitLab From 6e4ce429d8d43af1c8f70c6ea8cb69438d60e728 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 27 Jun 2025 10:07:12 +0200 Subject: [PATCH 4/6] doc: fix the howtoget intro after the source build has been extracted in its own page --- docs/index.rst | 1 - docs/introduction/howtoget.rst | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index dcd9ea71453f..3b86ee005cd7 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 Date: Fri, 27 Jun 2025 10:33:13 +0200 Subject: [PATCH 5/6] doc: group subpages of howtoget in appendix --- docs/introduction/howtoget.rst | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index 56afebac3eed..6ed19ab86257 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -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 -- GitLab From a8d551d1f23c66546d53121bf65b5c7523eb90d4 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 3 Jul 2025 15:09:23 +0200 Subject: [PATCH 6/6] doc: anyone can finalize unstake --- docs/alpha/staking.rst | 2 ++ docs/s023/staking.rst | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/alpha/staking.rst b/docs/alpha/staking.rst index 50baf482c31a..b51af8ef2fb0 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/s023/staking.rst b/docs/s023/staking.rst index 956f616f7dce..bf659557c3ae 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 -- GitLab