diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index c56014dcf44070d7d526ae1618af9a9b311da660..da0d7089890af05dd678be464446a86b5c5c3a7f 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/docs/alpha/accounts.rst b/docs/alpha/accounts.rst index 6920617e4204c9e290ddb2ed764ab9c8aecd3b89..f56d6ac458c387f82b4cc7f651c3117955056ffb 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/developer/error_monad_p3_advanced.rst b/docs/developer/error_monad_p3_advanced.rst index 49152860490fc82e9d483313901cea1f36fd8d89..2a46f600198a278463a0a5b5f53f1ad264b32c7d 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 7b83b02dc9c47fa4f10049e89f35db71f2a64bbb..065415c3758246d17a98753f236bb40a46bff69f 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/developer/ppx_expect.rst b/docs/developer/ppx_expect.rst index ef9f727a537f8f01cb85ddc8a726a2eff154219f..1d1bd2639998f809ac2bf919ce097588efb83c84 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. diff --git a/docs/oxford/accounts.rst b/docs/oxford/accounts.rst index 6920617e4204c9e290ddb2ed764ab9c8aecd3b89..f56d6ac458c387f82b4cc7f651c3117955056ffb 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 6920617e4204c9e290ddb2ed764ab9c8aecd3b89..f56d6ac458c387f82b4cc7f651c3117955056ffb 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. diff --git a/docs/shell/p2p.rst b/docs/shell/p2p.rst index 3be7bfc47b7f7609f87b032dfef5d9f1b7398ccc..178f2c49acdd737cbfbd4e503eeae89963f97e8d 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 diff --git a/manifest/externals.ml b/manifest/externals.ml index 6efef1adda641368b48660807cda72f7f2a05690..52120ea01765f46abea30b0b58d8bb7610db11c7 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 17b4f9de1062c15e8a93ca32ef5eec015890f170..f471761666a639b45a7ca33acb612c8ab8a6f832 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: [] diff --git a/scripts/version.sh b/scripts/version.sh index c4e939d5f63409ce639224b1e7df672a8e111c1b..742a8fe699726df4ec59a880967fa7a2c3a7cdf6 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"