From 88462b26de35162423f76d2f9a7314f1362bf9b0 Mon Sep 17 00:00:00 2001 From: Julien Sagot Date: Fri, 6 Sep 2024 11:50:49 +0200 Subject: [PATCH 1/3] Tezt: clearer Daemon module documentation --- tezt/lib_tezos/daemon.mli | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tezt/lib_tezos/daemon.mli b/tezt/lib_tezos/daemon.mli index 7f6f7db1dded..d04703cb1983 100644 --- a/tezt/lib_tezos/daemon.mli +++ b/tezt/lib_tezos/daemon.mli @@ -25,10 +25,10 @@ (** Parameters of the [Daemon.Make] functor. *) module type PARAMETERS = sig - (** Data to store whether a daemon is running or not. *) + (** User-defined read-only data stored when the daemon is created. *) type persistent_state - (** Data to store when a daemon is running. *) + (** User-defined read-only data set when the daemon is run and unset when the daemon terminates. *) type session_state (** Basis for the default value for the [?name] argument of [create]. -- GitLab From f6a4c8ec38c0ec091fecadb62ae9a47da2e83cca Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 17 Sep 2024 10:32:48 +0200 Subject: [PATCH 2/3] doc: fix missing slash in _redirects --- docs/_redirects | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_redirects b/docs/_redirects index 3f53cc100ddc..9a9b1893814c 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -141,4 +141,4 @@ /introduction/test_networks.html /user/multinetwork.html 301 /user/various.html /user/exits.html 301 /user/versioning.html /introduction/versioning.html 301 -/protocols/019_paris.html protocols/020_paris.html 301 +/protocols/019_paris.html /protocols/020_paris.html 301 -- GitLab From 53e32af3b5c8e96a2b120ee0248c155a21ec252a Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 18 Sep 2024 16:31:12 +0200 Subject: [PATCH 3/3] doc: fix some broken links --- docs/alpha/sapling.rst | 4 ++-- docs/conf.py | 8 ++++++++ docs/introduction/cosign-verify.rst | 6 +++--- docs/paris/sapling.rst | 4 ++-- docs/protocols/021_quebeca.rst | 2 +- docs/quebeca/sapling.rst | 4 ++-- docs/shell/smart_rollup_node.rst | 4 ++-- 7 files changed, 20 insertions(+), 12 deletions(-) diff --git a/docs/alpha/sapling.rst b/docs/alpha/sapling.rst index 2385c8dc6698..c7b5e1e7549e 100644 --- a/docs/alpha/sapling.rst +++ b/docs/alpha/sapling.rst @@ -40,7 +40,7 @@ transaction and produce the zero-knowledge proofs, which are computationally too intensive for an embedded device. More details can be found in the `specification document -`_. +`_. Shielded transactions ~~~~~~~~~~~~~~~~~~~~~ @@ -358,7 +358,7 @@ It can be generated from a mnemonic using `BIP39 that it can be recovered in case of loss using the mnemonic. Alternatively it is possible to derive new keys from existing ones using `ZIP32 -`_, a Sapling +`_, a Sapling variant of `BIP32 `_ for hierarchical deterministic wallets. As usual, in this case it is diff --git a/docs/conf.py b/docs/conf.py index f934183a9a17..763d805c8a33 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -268,6 +268,14 @@ linkcheck_allowed_redirects = dict( r'https://www.reddit.com/r/tezos/', r'https://www.reddit.com/r/tezos/[?]rdt=[0-9]+', ), + ( + r'https://ocaml\.org/api/.*', + r'https://ocaml\.org/manual/[0-9.]+/api/.*', + ), + ( + r'https://ocaml\.org/manual/.*', + r'https://ocaml\.org/manual/[0-9.]+/.*', + ), # 2. permanent redidections, maybe fix one day (r'https://bitheap\.org/cram/', r'https://github\.com/aiiie/cram'), ] diff --git a/docs/introduction/cosign-verify.rst b/docs/introduction/cosign-verify.rst index ef13d168c2f8..1fe9e24fa7ef 100644 --- a/docs/introduction/cosign-verify.rst +++ b/docs/introduction/cosign-verify.rst @@ -2,7 +2,7 @@ Verifying Octez Docker Images with Cosign ========================================== `Cosign `_ is a tool developed by `Sigstore -`_ to sign and verify container images and other +`_ to sign and verify container images and other artifacts. This document provides instructions on how to verify Docker images of Octez signed using Cosign. @@ -11,8 +11,8 @@ Prerequisites Before you can verify Docker images signed with Cosign, ensure you have Docker and Cosign installed on your system. -- `Docker Installation Guide `_ -- `Cosign Installation Guide `_ +- `Docker Installation Guide `_ +- `Cosign Installation Guide `_ Obtaining the Public Key ------------------------ diff --git a/docs/paris/sapling.rst b/docs/paris/sapling.rst index a53f2ac82715..5121b4df63b8 100644 --- a/docs/paris/sapling.rst +++ b/docs/paris/sapling.rst @@ -40,7 +40,7 @@ transaction and produce the zero-knowledge proofs, which are computationally too intensive for an embedded device. More details can be found in the `specification document -`_. +`_. Shielded transactions ~~~~~~~~~~~~~~~~~~~~~ @@ -358,7 +358,7 @@ It can be generated from a mnemonic using `BIP39 that it can be recovered in case of loss using the mnemonic. Alternatively it is possible to derive new keys from existing ones using `ZIP32 -`_, a Sapling +`_, a Sapling variant of `BIP32 `_ for hierarchical deterministic wallets. As usual, in this case it is diff --git a/docs/protocols/021_quebeca.rst b/docs/protocols/021_quebeca.rst index 6da540e52757..697a0870a5aa 100644 --- a/docs/protocols/021_quebeca.rst +++ b/docs/protocols/021_quebeca.rst @@ -83,7 +83,7 @@ RPC Changes - In the following paths, ``../`` is short for ``/chains//blocks//context/delegates//``. - See https://tezos.gitlab.io/beta/baking_power.html for more + See https://tezos.gitlab.io/quebeca/baking_power.html for more details on the renamed and new RPCs. * Renamed RPC ``GET ../current_frozen_deposits`` to ``GET diff --git a/docs/quebeca/sapling.rst b/docs/quebeca/sapling.rst index da9de7ce45d2..ff3bfa88b873 100644 --- a/docs/quebeca/sapling.rst +++ b/docs/quebeca/sapling.rst @@ -40,7 +40,7 @@ transaction and produce the zero-knowledge proofs, which are computationally too intensive for an embedded device. More details can be found in the `specification document -`_. +`_. Shielded transactions ~~~~~~~~~~~~~~~~~~~~~ @@ -358,7 +358,7 @@ It can be generated from a mnemonic using `BIP39 that it can be recovered in case of loss using the mnemonic. Alternatively it is possible to derive new keys from existing ones using `ZIP32 -`_, a Sapling +`_, a Sapling variant of `BIP32 `_ for hierarchical deterministic wallets. As usual, in this case it is diff --git a/docs/shell/smart_rollup_node.rst b/docs/shell/smart_rollup_node.rst index 444d729cece3..6fe797c1c207 100644 --- a/docs/shell/smart_rollup_node.rst +++ b/docs/shell/smart_rollup_node.rst @@ -856,10 +856,10 @@ The available options are: - Description * - Singlepass - ``singlepass`` - - `When to use Singlepass `_ + - `When to use Singlepass `_ * - Cranelift - ``cranelift`` - - `When to use Cranelift `_ + - `When to use Cranelift `_ Note that while the rollup node is generally capable of using Wasmer's LLVM-based compiler, Octez does not currently ship with it. -- GitLab