From 99f10a6414bb79722ba99442a622d215c89a4841 Mon Sep 17 00:00:00 2001 From: Arvid Jakobsson Date: Fri, 15 Mar 2024 11:21:32 +0100 Subject: [PATCH 1/5] docs: fix link and replace superseded doc for P-256 --- docs/alpha/accounts.rst | 2 +- docs/oxford/accounts.rst | 2 +- docs/paris/accounts.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/alpha/accounts.rst b/docs/alpha/accounts.rst index 6920617e4204..f56d6ac458c3 100644 --- a/docs/alpha/accounts.rst +++ b/docs/alpha/accounts.rst @@ -61,7 +61,7 @@ Addresses that start with the ``tz3`` prefix are hashes of P-256 public keys and signatures must be produced by using the `EcDSA signature scheme `_ with the `P-256 curve -`_, also known as +`_, also known as Secp256r1. This is one of the curves for EcDSA recommended by NIST. It is also often the only cryptographic scheme supported by HSMs (Hardware Security Modules) of cloud providers. diff --git a/docs/oxford/accounts.rst b/docs/oxford/accounts.rst index 6920617e4204..f56d6ac458c3 100644 --- a/docs/oxford/accounts.rst +++ b/docs/oxford/accounts.rst @@ -61,7 +61,7 @@ Addresses that start with the ``tz3`` prefix are hashes of P-256 public keys and signatures must be produced by using the `EcDSA signature scheme `_ with the `P-256 curve -`_, also known as +`_, also known as Secp256r1. This is one of the curves for EcDSA recommended by NIST. It is also often the only cryptographic scheme supported by HSMs (Hardware Security Modules) of cloud providers. diff --git a/docs/paris/accounts.rst b/docs/paris/accounts.rst index 6920617e4204..f56d6ac458c3 100644 --- a/docs/paris/accounts.rst +++ b/docs/paris/accounts.rst @@ -61,7 +61,7 @@ Addresses that start with the ``tz3`` prefix are hashes of P-256 public keys and signatures must be produced by using the `EcDSA signature scheme `_ with the `P-256 curve -`_, also known as +`_, also known as Secp256r1. This is one of the curves for EcDSA recommended by NIST. It is also often the only cryptographic scheme supported by HSMs (Hardware Security Modules) of cloud providers. -- GitLab From e6da09f261d249a6a81f04fa492299897f82ece4 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 19 Mar 2024 14:06:06 +0100 Subject: [PATCH 2/5] doc: restrict version of Odoc --- manifest/externals.ml | 4 +++- opam/virtual/octez-dev-deps.opam | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/manifest/externals.ml b/manifest/externals.ml index 6efef1adda64..52120ea01765 100644 --- a/manifest/externals.ml +++ b/manifest/externals.ml @@ -367,7 +367,9 @@ let () = (add_dep_to_profile "octez-dev-deps") [ external_lib "merlin" V.(at_least "4.14"); - external_lib "odoc" V.True; + (* TODO: https://gitlab.com/tezos/tezos/-/issues/7085 + remove constraint on odoc version when odoc bug is solved *) + external_lib "odoc" V.(at_least "2.2.0" && less_than "2.3.0"); external_lib "ocp-indent" V.True; external_lib "ocaml-lsp-server" V.(at_least "1.17.0"); external_lib "merge-fmt" V.True; diff --git a/opam/virtual/octez-dev-deps.opam b/opam/virtual/octez-dev-deps.opam index 17b4f9de1062..f471761666a6 100644 --- a/opam/virtual/octez-dev-deps.opam +++ b/opam/virtual/octez-dev-deps.opam @@ -14,7 +14,7 @@ depends: [ "merlin" { >= "4.14" } "ocaml-lsp-server" { >= "1.17.0" } "ocp-indent" - "odoc" + "odoc" { >= "2.2.0" & < "2.3.0" } "utop" { >= "2.8" } ] build: [] -- GitLab From f8e0f3c58f13b8f24f89b1edd50a6d4d0096cc49 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 19 Mar 2024 16:33:10 +0100 Subject: [PATCH 3/5] doc: fix broken link to ppx_expect x LWT --- docs/developer/ppx_expect.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/ppx_expect.rst b/docs/developer/ppx_expect.rst index ef9f727a537f..1d1bd2639998 100644 --- a/docs/developer/ppx_expect.rst +++ b/docs/developer/ppx_expect.rst @@ -147,6 +147,6 @@ Integration with Lwt --------------------- Ppx_expect can be used in combination with Lwt, see the -`README `_. +`package description `_. This integration has not been tested on the Octez codebase yet, hence some work will be needed to a have specific support for the codebase. -- GitLab From 7220d74fe56126764fdd185ba0013a97ea343fc3 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 22 Mar 2024 11:27:06 +0100 Subject: [PATCH 4/5] doc: fix several links to OCaml APIs --- docs/developer/error_monad_p3_advanced.rst | 4 ++-- docs/developer/event_logging_framework.rst | 2 +- docs/shell/p2p.rst | 12 ++++++------ 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/developer/error_monad_p3_advanced.rst b/docs/developer/error_monad_p3_advanced.rst index 49152860490f..2a46f600198a 100644 --- a/docs/developer/error_monad_p3_advanced.rst +++ b/docs/developer/error_monad_p3_advanced.rst @@ -62,8 +62,8 @@ for ``List.map`` 'a list -> ('b list, 'trace list) result Lwt.t -Check out `the online documentation of -Lwtreslib <../api/odoc/_html/tezos-lwt-result-stdlib/Tezos_lwt_result_stdlib/Lwtreslib/index.html>`__ +Check out :package-api:`the online documentation of +Lwtreslib ` for a description of the semantic and naming convention. In addition to shadowing existing modules, ``Lwtreslib`` also exports diff --git a/docs/developer/event_logging_framework.rst b/docs/developer/event_logging_framework.rst index 7b83b02dc9c4..065415c37582 100644 --- a/docs/developer/event_logging_framework.rst +++ b/docs/developer/event_logging_framework.rst @@ -34,7 +34,7 @@ See for instance ``val Simple.emit: 'a Simple.t -> 'a -> (unit, trace) result Lwt.t``. Please read the guidelines that are documented in -`the Internal_event.Simple module. <../api/odoc/_html/octez-libs/Event_logging/Internal_event/Simple/index.html>`__ +:package-api:`the Internal_event.Simple module. `. “Heavy” Events diff --git a/docs/shell/p2p.rst b/docs/shell/p2p.rst index 3be7bfc47b7f..178f2c49acdd 100644 --- a/docs/shell/p2p.rst +++ b/docs/shell/p2p.rst @@ -49,8 +49,8 @@ are used to store incoming (resp. outgoing) messages for each peer. This further restricts the speed at which communication is possible with a peer; when a queue is full, it is not possible to read (resp. write) an additional message. The high-level -`P2p_socket.t -<../api/odoc/_html/tezos-p2p/Tezos_p2p/P2p_socket/index.html#type-t>`__ +:package-api:`P2p_socket.t +` type defined by the P2P layer is basically a UNIX socket upgraded with I/O scheduling, peer metadata, cryptographic keys, and two message queues operated by dedicated workers which operate on those queues. @@ -58,16 +58,16 @@ operated by dedicated workers which operate on those queues. Pool of connections ~~~~~~~~~~~~~~~~~~~ -All the above modules are used in `P2p_pool -<../api/api-inline.html#tezos-p2p/Tezos_p2p/P2p_pool/index.html>`__, which +All the above modules are used in :package-api:`P2p_pool +`, which constitutes the core of the P2P layer, together with the worker processes described below. It comprises various tables of connections as well as methods to query them, also connections are extended with another message queue where lower-level messages (like responses to ping) are filtered out and only application-level messages are kept. -The main entry point of the P2P layer is in module `P2p -<../api/api-inline.html#tezos-p2p/Tezos_p2p/P2p/index.html>`__. See below +The main entry point of the P2P layer is in module :package-api:`P2p +`. See below for a description of workers acting onto the P2P layer. Welcome worker & connect handler -- GitLab From 2989571085273565164407bb0106bce8d058c0b8 Mon Sep 17 00:00:00 2001 From: Arvid Jakobsson Date: Fri, 22 Mar 2024 11:55:44 +0100 Subject: [PATCH 5/5] Opam: bump to version where odoc is restricted to 2.2.0 See https://gitlab.com/tezos/opam-repository/-/merge_requests/502/ --- .gitlab-ci.yml | 2 +- scripts/version.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index c56014dcf440..da0d7089890a 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -59,7 +59,7 @@ default: interruptible: true variables: - build_deps_image_version: df242dbcfa69587ccc182e4f3c3c02288407a097 + build_deps_image_version: 67ce701b064abbeba43ab1b45286e59383e116b6 build_deps_image_name: ${GCP_REGISTRY}/tezos/opam-repository rust_toolchain_image_name: ${GCP_REGISTRY}/${CI_PROJECT_PATH}/rust-toolchain client_libs_dependencies_image_name: ${GCP_REGISTRY}/${CI_PROJECT_PATH}/client-libs-dependencies diff --git a/scripts/version.sh b/scripts/version.sh index c4e939d5f634..742a8fe69972 100755 --- a/scripts/version.sh +++ b/scripts/version.sh @@ -32,7 +32,7 @@ export full_opam_repository_tag=2314da5646931ec7f643bdc9aaa39177971ac857 ## This value MUST be reflected in the `build_deps_image_version` variable ## of `.gitlab-ci.yml`, which is ensured by running `make -C ci` from the root. export opam_repository_url=https://gitlab.com/tezos/opam-repository -export opam_repository_tag="${OPAM_REPOSITORY_TAG:-df242dbcfa69587ccc182e4f3c3c02288407a097}" +export opam_repository_tag="${OPAM_REPOSITORY_TAG:-67ce701b064abbeba43ab1b45286e59383e116b6}" export opam_repository_git="$opam_repository_url.git" export opam_repository="$opam_repository_git"\#"$opam_repository_tag" -- GitLab