From 3d8db75c826bcd6f3ce8aa160152f5c124843b06 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 26 Aug 2025 18:06:41 +0200 Subject: [PATCH 01/10] doc: fix 2 linkcheck errors --- docs/developer/alcotezt.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer/alcotezt.rst b/docs/developer/alcotezt.rst index 5af3bdbc7681..ccfb9a000a34 100644 --- a/docs/developer/alcotezt.rst +++ b/docs/developer/alcotezt.rst @@ -16,7 +16,7 @@ function. This will: - Create a *test executable* ``main.exe`` in the test folder. The test executable links with the test library and consists of a single call to Tezt's `Test.run - `__. + `__. - Finally, link the test library with Tezt's main entrypoint at ``tezt/tests/main.exe`` so that it registers all Alcotezts. @@ -153,7 +153,7 @@ Test Output +++++++++++ Alcotezt redirects ``Format``'s output to Tezt's `Log.debug -`__. +`__. To see the debug output of an Alcotezt, pass the ``--verbose`` flag to Tezt. See the section :ref:`running-alcotezts` above for more information on how to pass flags to Tezt when executing Alcotezts. -- GitLab From f10b77fdaa7c56331cd93035ba060c4b2b919062 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 27 Aug 2025 15:38:57 +0200 Subject: [PATCH 02/10] doc: rewrite external links in page staking.rst --- docs/alpha/staking.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/alpha/staking.rst b/docs/alpha/staking.rst index c7b5c1746bbb..4446acbf5645 100644 --- a/docs/alpha/staking.rst +++ b/docs/alpha/staking.rst @@ -1,8 +1,6 @@ .. note:: - For information about how to stake, see `Staking `__ on docs.tezos.com. - - For operational details about the staking mechanism and its configuration, see `a staking mechanism tutorial `__. + To stake easily, directly from a user wallet, see `Staking `__ on docs.tezos.com. ================= Staking mechanism @@ -227,3 +225,7 @@ to be delegated to the old delegate, however the spending balance of the account is accounted in the new delegate's stake. It will not be possible to stake with the new delegate as long as there are unfinalizable unstake request for token staked with the old delegate. + +.. note:: + + For further details about the staking mechanism and its configuration, see `a staking mechanism tutorial `__. -- GitLab From a60527c1ceb676e56237c3bf16b045ded5ab70bb Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Wed, 27 Aug 2025 16:06:02 -0400 Subject: [PATCH 03/10] Add space so list renders properly --- docs/user/node-configuration.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/user/node-configuration.rst b/docs/user/node-configuration.rst index 695e9830aca1..92f25eb5a428 100644 --- a/docs/user/node-configuration.rst +++ b/docs/user/node-configuration.rst @@ -367,6 +367,7 @@ Note that UPnP is generally not supported by professional networks, and might not be enabled by default in home networks. The general workflow of using UPnP with Octez v23 is the following: + 1. Ask for a redirection of the P2P port on any port: :: -- GitLab From 52b2016831a56be35c65f7833018bbe5fae6c267 Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Tue, 2 Sep 2025 07:50:31 -0400 Subject: [PATCH 04/10] Typo --- docs/introduction/howtoget.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index 8e828dbaa870..d062da2ce704 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -62,7 +62,7 @@ When it comes to installing software, especially for critical applications like Tezos/Octez, it’s crucial to ensure a secure and stable environment. While compiling from source can provide customization options, it often introduces complexities and risks. -Instead, opting for binary packages sucha as Deb or RPM packages from a trusted source simplifies +Instead, opting for binary packages such as Deb or RPM packages from a trusted source simplifies installation and enhances security. Deb or RPM packages compiled for a specific platform should be always preferred -- GitLab From 8ed14a1c6acfa4dde9a23fd271015e99e60aa3f4 Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Tue, 2 Sep 2025 15:13:20 -0400 Subject: [PATCH 05/10] How to sync with NTP --- docs/introduction/howtouse.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/introduction/howtouse.rst b/docs/introduction/howtouse.rst index f491daac43e4..de43b7f7ea88 100644 --- a/docs/introduction/howtouse.rst +++ b/docs/introduction/howtouse.rst @@ -138,7 +138,9 @@ concurrently and selects the best one based on its fitness (see `__ to avoid clock drift. Clock drift may result in not being able to get recent blocks in case of negative lag time, and in not being able to inject new blocks in case of - positive lag time. + positive lag time. Refer to your operating system's documentation for + instructions on setting a "time server" or "time service" to sync your + computer's time with an NTP server. Node Synchronization ~~~~~~~~~~~~~~~~~~~~ -- GitLab From 7ab7be019f4fb322679daf1253086a73a4f9d3c3 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 4 Sep 2025 10:32:34 +0200 Subject: [PATCH 06/10] doc: link supported platforms in serokell.rst --- docs/introduction/serokell.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction/serokell.rst b/docs/introduction/serokell.rst index 0283555dfa35..c7b6a4fb6cba 100644 --- a/docs/introduction/serokell.rst +++ b/docs/introduction/serokell.rst @@ -32,7 +32,7 @@ If you were using RPM packages, use ``dnf`` instead of ``apt``. 3. Add NL Repository -------------------- -**If using Debian**, add the NL package repository and install the ``octez-node`` package: +**If using Debian** (see other :ref:`supported platforms `), add the NL package repository and install the ``octez-node`` package: .. code:: shell -- GitLab From 61b85f4e7e7f6bfca27746c1839d31759b5ff20d Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Fri, 5 Sep 2025 14:00:08 -0400 Subject: [PATCH 07/10] Per !19151, mention these folders --- docs/introduction/howtouse.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/introduction/howtouse.rst b/docs/introduction/howtouse.rst index de43b7f7ea88..3aea7adad42b 100644 --- a/docs/introduction/howtouse.rst +++ b/docs/introduction/howtouse.rst @@ -177,6 +177,7 @@ Data directory The node stores data in a data directory, which by default is ``$HOME/.tezos-node/``. The ``--data-dir`` argument, available on many node commands, sets the location of this directory. +This data includes the current context (in the ``context`` directory) and daily logs (in the ``daily_logs`` directory). One exception is the configuration file, which is stored in the data directory by default but can be stored in a different location with the ``--config-file`` argument. If for some reason your node is misbehaving or there has been an -- GitLab From fa2c2cbc5eca904a8eee20a566eb9bcde8267e92 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 8 Sep 2025 17:56:53 +0200 Subject: [PATCH 08/10] doc: describe v23.2 in release page --- docs/releases/version-23.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/releases/version-23.rst b/docs/releases/version-23.rst index 577dd3d64d41..a3075cc75ae6 100644 --- a/docs/releases/version-23.rst +++ b/docs/releases/version-23.rst @@ -15,6 +15,12 @@ Version 23 introduces the following changes or new features: Octez v23.1 addresses an issue with Ubuntu and Debian packages distribution, where an expired PGP key prevented users from updating to v23.0 using apt. +Octez v23.2 fixes an issue affecting ``systemd`` services of Debian and Ubuntu packages that could lead to having two baking binaries running at the same time. + +In some cases, this issue could cause bakers to lose consensus rewards or, in certain conditions, could result in double-signing. Consequently, v23.0 and v23.1 Ubuntu and Debian packages were made unavailable via ``apt`` and ``dnf``. The release of v23.2 restores the availability of these distribution packages. + +**For all other distributions, this version is the same as Octez v23.1** + .. _protocol_support_v23: Protocol Support @@ -90,12 +96,12 @@ Ubuntu and Debian packages .. note:: Because the PGP keys have been rotated, users updating packages need to overwrite the previously installed octez.gpg key. - For example, in order to update to v23.1 from a pre-existing Ubuntu Noble deployment, a user should first update the keys with:: + For example, in order to update to v23.2 from a pre-existing Ubuntu Noble deployment, a user should first update the keys with:: curl -s "https://packages.nomadic-labs.com/ubuntu/octez.asc" | sudo gpg --yes --dearmor -o /etc/apt/keyrings/octez.gpg - Then, they should be able to continue upgrading as usual, e.g. by:: + Then, Octez packages users are advised to stop ``systemd`` services before updating to v23.2:: sudo apt-get update sudo apt-get upgrade octez-baker -- GitLab From cbb64c4e4cc206cb39724582d88a2cdae37f508a Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 10 Sep 2025 08:05:17 +0000 Subject: [PATCH 09/10] doc: remove generic instructions not applicable to v23 --- docs/releases/version-23.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/releases/version-23.rst b/docs/releases/version-23.rst index a3075cc75ae6..203da006957c 100644 --- a/docs/releases/version-23.rst +++ b/docs/releases/version-23.rst @@ -88,11 +88,6 @@ Update Instructions Ubuntu and Debian packages ~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. code-block:: shell - - sudo apt update - sudo apt upgrade octez-node octez-client octez-baker octez-dal-node octez-smart-rollup-node - .. note:: Because the PGP keys have been rotated, users updating packages need to overwrite the previously installed octez.gpg key. -- GitLab From 8e81e6d9c9444c15a38d0678924926e3a854015b Mon Sep 17 00:00:00 2001 From: Tim McMackin Date: Wed, 10 Sep 2025 09:09:45 -0400 Subject: [PATCH 10/10] Fix link --- docs/introduction/howtoget.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index d062da2ce704..e8a70aa4245f 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -251,7 +251,7 @@ Using Homebrew On macOS and Linux, you can compile and install Octez using Homebrew. If Homebrew is not yet installed on your system, please refer to the official -[Homebrew installation guide](https://brew.sh/) for detailed instructions. +`Homebrew installation guide `__ for detailed instructions. Once Homebrew is set up, follow these steps to install Octez. -- GitLab