From 9d0369559ba7d5fd9745a61fbc78c5c007d5c765 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 26 Sep 2024 17:35:33 +0200 Subject: [PATCH 1/8] doc: show how to compile only some executables --- docs/introduction/howtoget.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index fb322febae2a..6baedc46bb7d 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -454,6 +454,7 @@ Setting up the development environment from scratch If you plan to contribute to the Octez codebase, the way to go is to set up a complete development environment, by cloning the repository and compiling the sources using the provided makefile. +You may either build all the executables, as illustrated below, or only a subset of the executables, as detailed in section :ref:`compile_sources`. **TL;DR**: From a fresh Debian Bookworm x86_64, you typically want to select a source branch in the Octez repository, e.g.: @@ -633,17 +634,24 @@ command instead: * As a last resort, removing the ``_opam`` folder (as part of a ``git clean -dxf`` for example) allows to restart in a fresh environment. +.. _compile_sources: + Compile ~~~~~~~ Once the dependencies are installed we can update OPAM's environment to -refer to the new switch and compile the project: +refer to the new switch and compile the project to build all the executables: .. literalinclude:: compile-sources.sh :language: shell :start-after: [compile sources] :end-before: [optional setup] +.. note:: + + Instead of the simple ``make`` command above, you may use more restrictive targets in :src:`the makefile ` to build only some subset of the executables. + For instance, you may exclude experimental executables using ``make release``; furthermore exclude executables such as the EVM node using ``make octez``; or even restrict to Layer 1 executables using ``make octez-layer1``. + Lastly, you can also add the Octez binaries to your ``PATH`` variable, and after reading the Disclaimer a few hundred times you are allowed to disable it with -- GitLab From 9c00ea2433ef423476409d1a0152f83c52d49b81 Mon Sep 17 00:00:00 2001 From: Julien Sagot Date: Fri, 27 Sep 2024 14:54:12 +0200 Subject: [PATCH 2/8] ci: fix examples in comment not matching regexp described --- ci/bin/main.ml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ci/bin/main.ml b/ci/bin/main.ml index f8e51e0d841f..6b015fdd1995 100644 --- a/ci/bin/main.ml +++ b/ci/bin/main.ml @@ -130,11 +130,11 @@ let () = (** {3 Release pipelines} *) let () = - (* Matches Octez release tags, e.g. [octez-v1.2.3] or [octez-v1.2.3-rc4]. *) + (* Matches Octez release tags, e.g. [octez-v1.2] or [octez-v1.2-rc4]. *) let octez_release_tag_re = "/^octez-v\\d+\\.\\d+(?:\\-rc\\d+)?$/" in - (* Matches Octez beta release tags, e.g. [octez-v1.2.3-beta5]. *) + (* Matches Octez beta release tags, e.g. [octez-v1.2-beta5]. *) let octez_beta_release_tag_re = "/^octez-v\\d+\\.\\d+\\-beta\\d*$/" in - (* Matches Etherlink release tags, e.g. [etherlink-v1.2.3] or [etherlink-v1.2.3-rc4]. *) + (* Matches Etherlink release tags, e.g. [etherlink-v1.2] or [etherlink-v1.2-rc4]. *) let octez_evm_node_release_tag_re = "/^octez-evm-node-v\\d+\\.\\d+(?:\\-rc\\d+)?$/" in -- GitLab From acef4facb38b42ef029848f0dfed319e7e24898f Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 27 Sep 2024 17:00:09 +0200 Subject: [PATCH 3/8] doc: parameterize linkcheck for flaky links --- docs/conf.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 2565a12ea243..feb22f11d9cc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -236,7 +236,11 @@ texinfo_documents = [ # -- Ignore fragments in linkcheck +# Check the existence of given anchors (suffixes of the form "#label") in URLs linkcheck_anchors = False +# linkcheck_report_timeouts_as_broken = False # (default) +# linkcheck_timeout = 30 # (default) +linkcheck_retries = 2 linkcheck_ignore = [ # links which may fail for lack of access rights: r'^https://gitlab\.com/nomadic-labs/tezos/-/merge_requests/', @@ -249,9 +253,6 @@ linkcheck_ignore = [ r'^https://opentezos\.com/', r'^https://crates\.io/crates/tezos-smart-rollup', r'^https://rpc\.ghostnet\.teztnets\.com/chains/main/blocks/', - r'^https://gitlab\.com/tezos/tezos/-/merge_requests/2771', - r'^https://gitlab\.com/tezos/tezos/-/merge_requests/3225', - r'^https://gitlab\.com/tezos/tezos/-/merge_requests/3267', ] linkcheck_allowed_redirects = dict( [ -- GitLab From d34622de8342f880aa34a0f3cf16c9244a3b1478 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 30 Sep 2024 16:22:32 +0200 Subject: [PATCH 4/8] doc: fix link to baker manual in v21 --- docs/releases/version-21.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releases/version-21.rst b/docs/releases/version-21.rst index c7b6fe3c492d..fc67cfe5d498 100644 --- a/docs/releases/version-21.rst +++ b/docs/releases/version-21.rst @@ -50,7 +50,7 @@ the new safety net. Not applying round 1 -- 2 block proposals by default while creating them will allow for faster propagation and earlier consensus -agreement. See `here <../../quebeca/cli-commands.html#baker-manual>`__ +agreement. See :ref:`here ` for further details on how bakers can fine-tune this parameter. DAL node -- GitLab From 9462abc9d147bc83272ce00e58ca2ffa2ed780a1 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 1 Oct 2024 16:28:05 +0200 Subject: [PATCH 5/8] doc: mention logging UX in release 21 --- docs/releases/version-21.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/releases/version-21.rst b/docs/releases/version-21.rst index fc67cfe5d498..9f8e5f59db5a 100644 --- a/docs/releases/version-21.rst +++ b/docs/releases/version-21.rst @@ -78,7 +78,16 @@ node, driven by the deployment of Etherlink Mainnet beta in May. These include: an improved UX for decentralized applications relying on the outbox of a Smart Rollup, like the Etherlink native bridge. -Please see the Changelog for further information and other optimizations. +Better logging UX +~~~~~~~~~~~~~~~~~ + +Octez v21.0 introduces several UX improvements to the :doc:`logging infrastructure <../user/logging>` including: + +- Clearer reporting of outdated nonces in baker logs +- Listing the set of delegates used by a baker at startup +- Coloured logs for most Octez binaries (including the node, baker and accuser) + +Please see the `Changelog`_ for further information and other optimizations. Update Instructions ------------------- -- GitLab From bd5efdca39ccb0a19b6294a133734b821c6b964d Mon Sep 17 00:00:00 2001 From: Julien Sagot Date: Wed, 2 Oct 2024 09:20:03 +0200 Subject: [PATCH 6/8] profiler/doc: fix a function referencing itself --- src/lib_base/profiler.mli | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib_base/profiler.mli b/src/lib_base/profiler.mli index b838c7a4c148..ad2b76e503e3 100644 --- a/src/lib_base/profiler.mli +++ b/src/lib_base/profiler.mli @@ -229,7 +229,7 @@ val inc : profiler -> report -> unit ]} *) val record_f : profiler -> ?lod:lod -> string -> (unit -> 'a) -> 'a -(** Same as [record_s] but for Lwt function *) +(** Same as [record_f] but for Lwt function *) val record_s : profiler -> ?lod:lod -> string -> (unit -> 'a Lwt.t) -> 'a Lwt.t (** [aggregate_f profiler ?lod label f] will call: -- GitLab From 120b86a33b7fe7603b457475e2d2e3dcac44827e Mon Sep 17 00:00:00 2001 From: Julien Sagot Date: Wed, 2 Oct 2024 09:27:12 +0200 Subject: [PATCH 7/8] profiler/doc: use odoc references instead of simple code markup --- src/lib_base/profiler.mli | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/lib_base/profiler.mli b/src/lib_base/profiler.mli index ad2b76e503e3..8c3c753a95b7 100644 --- a/src/lib_base/profiler.mli +++ b/src/lib_base/profiler.mli @@ -229,7 +229,7 @@ val inc : profiler -> report -> unit ]} *) val record_f : profiler -> ?lod:lod -> string -> (unit -> 'a) -> 'a -(** Same as [record_f] but for Lwt function *) +(** Same as {!record_f} but for Lwt function *) val record_s : profiler -> ?lod:lod -> string -> (unit -> 'a Lwt.t) -> 'a Lwt.t (** [aggregate_f profiler ?lod label f] will call: @@ -240,7 +240,7 @@ val record_s : profiler -> ?lod:lod -> string -> (unit -> 'a Lwt.t) -> 'a Lwt.t ]} *) val aggregate_f : profiler -> ?lod:lod -> string -> (unit -> 'a) -> 'a -(** Same as [aggregate_f] but for Lwt functions *) +(** Same as {!aggregate_f} but for Lwt functions *) val aggregate_s : profiler -> ?lod:lod -> string -> (unit -> 'a Lwt.t) -> 'a Lwt.t @@ -248,7 +248,7 @@ val aggregate_s : specifically around [f] *) val span_f : profiler -> ?lod:lod -> string list -> (unit -> 'a) -> 'a -(** Same as [span_f] but for Lwt functions *) +(** Same as {!span_f} but for Lwt functions *) val span_s : profiler -> ?lod:lod -> string list -> (unit -> 'a Lwt.t) -> 'a Lwt.t @@ -322,7 +322,7 @@ module type GLOBAL_PROFILER = sig ]} *) val record_f : ?lod:lod -> string -> (unit -> 'a) -> 'a - (** Same as [record_f] but for Lwt function *) + (** Same as {!record_f} but for Lwt function *) val record_s : ?lod:lod -> string -> (unit -> 'a Lwt.t) -> 'a Lwt.t (** [aggregate_f ?lod label f] will call: @@ -333,18 +333,18 @@ module type GLOBAL_PROFILER = sig ]} *) val aggregate_f : ?lod:lod -> string -> (unit -> 'a) -> 'a - (** Same as [aggregate_f] but for Lwt functions *) + (** Same as {!aggregate_f} but for Lwt functions *) val aggregate_s : ?lod:lod -> string -> (unit -> 'a Lwt.t) -> 'a Lwt.t (** [span_f ?lod label_list f] will compute [span] but specifically around [f] *) val span_f : ?lod:lod -> string list -> (unit -> 'a) -> 'a - (** Same as [span_f] but for Lwt functions *) + (** Same as {!span_f} but for Lwt functions *) val span_s : ?lod:lod -> string list -> (unit -> 'a Lwt.t) -> 'a Lwt.t end -(** [wrap profiler] stores [profiler] in a [GLOBAL_PROFILER] module +(** [wrap profiler] stores [profiler] in a {!GLOBAL_PROFILER} module allowing to use the [profiler] functions without having to provide it as a parameter *) val wrap : profiler -> (module GLOBAL_PROFILER) -- GitLab From 623af63fc9b09e93a898d28afd59f3435700be87 Mon Sep 17 00:00:00 2001 From: Killian Delarue Date: Wed, 2 Oct 2024 14:27:25 +0200 Subject: [PATCH 8/8] Docs: Fix Poetry version typo --- docs/developer/install-python-debian-ubuntu.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/install-python-debian-ubuntu.sh b/docs/developer/install-python-debian-ubuntu.sh index 1f1f8f27cd5e..6b4e8a060c61 100755 --- a/docs/developer/install-python-debian-ubuntu.sh +++ b/docs/developer/install-python-debian-ubuntu.sh @@ -94,7 +94,7 @@ python install-poetry.py --version 1.8.3 --yes export PATH=$PATH:$HOME/.local/bin # [print poetry version] -poetry --version # should output 1.2.2 +poetry --version # should output 1.8.3 # [verify poetry version] [ "$(poetry --version)" = "Poetry (version 1.8.3)" ] -- GitLab