From fe75c0da5b2ad6e35a199e4a35498f599cd1fb08 Mon Sep 17 00:00:00 2001 From: Killian Delarue Date: Tue, 30 Apr 2024 11:22:20 +0200 Subject: [PATCH 1/5] Docs, v20: Fix git tag --- docs/releases/version-20.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releases/version-20.rst b/docs/releases/version-20.rst index c94fd23205be..19264adb8591 100644 --- a/docs/releases/version-20.rst +++ b/docs/releases/version-20.rst @@ -44,7 +44,7 @@ Update Instructions To update from sources:: git fetch - git checkout v20.0-rc1 + git checkout octez-v20.0-rc1 make clean opam switch remove . # To be used if the next step fails make build-deps -- GitLab From 539406c0fad20c58dddde937f9e9c5e8833be2a4 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 7 May 2024 08:55:01 +0200 Subject: [PATCH 2/5] doc: fix syntax for italics --- docs/shell/smart_rollup_node.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/shell/smart_rollup_node.rst b/docs/shell/smart_rollup_node.rst index fbc2bf30023b..3894cdb2e803 100644 --- a/docs/shell/smart_rollup_node.rst +++ b/docs/shell/smart_rollup_node.rst @@ -1670,7 +1670,7 @@ required, and output some information about the run. Full execution with padding: 22000000000 ticks Each cycle is a call of the ``kernel_run`` function. -For each cycle, the number of _effective_ ticks used is shown (ticks corresponding +For each cycle, the number of *effective* ticks used is shown (ticks corresponding to execution, and not used for padding), along with the duration in seconds. It is also possible to show the outbox for any given level (``show -- GitLab From 25916704729eb769d8207f1e7647d6fa43241055 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 7 May 2024 08:55:12 +0200 Subject: [PATCH 3/5] doc: rename trailing implicit account --- docs/alpha/michelson.rst | 2 +- docs/shell/smart_rollup_node.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/alpha/michelson.rst b/docs/alpha/michelson.rst index 0b9240a8cb99..77a3b8cc11e5 100644 --- a/docs/alpha/michelson.rst +++ b/docs/alpha/michelson.rst @@ -84,7 +84,7 @@ Transaction semantics ~~~~~~~~~~~~~~~~~~~~~ On one hand, a smart call may result from an external operation of kind Transaction. -External operations are :doc:`blockchain operations <./blocks_ops>` included in a block, signed by an implicit account. +External operations are :doc:`blockchain operations <./blocks_ops>` included in a block, signed by a user account. On the other hand, a smart contract call may be emitted as an internal operation of kind Transaction, either when executing another smart contract call or when :ref:`triggering the execution of an outbox message from a smart rollup `. diff --git a/docs/shell/smart_rollup_node.rst b/docs/shell/smart_rollup_node.rst index 3894cdb2e803..6dde2cb434ae 100644 --- a/docs/shell/smart_rollup_node.rst +++ b/docs/shell/smart_rollup_node.rst @@ -1481,9 +1481,9 @@ with the following schema: [ [ { "payload" : , - "sender" : , + "sender" : , "source" : - "destination" : } + "destination" : } .. // or { "external" : } -- GitLab From 2d1b844c417cd0c1c973b42e279f4b47a7bf0414 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 14 May 2024 14:49:09 +0200 Subject: [PATCH 4/5] doc: recommend bakers to save nonces --- docs/introduction/howtorun.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/introduction/howtorun.rst b/docs/introduction/howtorun.rst index 41108db7b217..7bcaba269cf8 100644 --- a/docs/introduction/howtorun.rst +++ b/docs/introduction/howtorun.rst @@ -198,6 +198,10 @@ However, it is safe (and actually necessary) to temporarily run two bakers just The baker uses the same format of configuration file as the client (see :ref:`client_conf_file`). +.. warning:: + + When running a baker, it is recommended to carefully save the nonces generated by the baker as part of the :doc:`consensus protocol <../active/consensus>`, to be able to reveal the nonces before the end of the cycle even if the baker is restarted (e.g., on another machine), so as to avoid losing :ref:`attestation rewards `. + Accuser ~~~~~~~ -- GitLab From 81cb427d0f632b100c58f91f7366fbad64556903 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 17 May 2024 16:38:51 +0200 Subject: [PATCH 5/5] doc: clarifications in the add-opam-dep guide --- .../contributing-adding-a-new-opam-dependency.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/developer/contributing-adding-a-new-opam-dependency.rst b/docs/developer/contributing-adding-a-new-opam-dependency.rst index 38fcb1a9359b..ce26e50596a3 100644 --- a/docs/developer/contributing-adding-a-new-opam-dependency.rst +++ b/docs/developer/contributing-adding-a-new-opam-dependency.rst @@ -50,7 +50,7 @@ but that you installed *development* dependencies Local work ---------- -The simplest way of using a new dependency on the Octez codebase when working +The simplest way of using a new dependency on the Octez codebase when working locally (i.e., on your own machine) is to install it using ``opam``. Because you have used ``make build-dev-deps`` in order to install the @@ -132,12 +132,13 @@ In order to create the opam repository MR: - Push your branch. - Create the opam repository MR from this branch. -You can test the MR locally using the command +You can test the result by running the following command in your local copy of Octez: ``OPAM_REPOSITORY_TAG= make build-deps``. This will rebuild the dependencies locally using the ```` of the opam-repository. -Fourth, back in your local copy of Octez, **update the** ``opam_repository_tag`` -**variable in the** :src:`scripts/version.sh` **file**. Specifically, set it +Fourth, in your local copy of Octez, **update the** ``opam_repository_tag`` +**variable in the** :src:`scripts/version.sh` **file**. (**NB**: do not confuse this variable with the ``full_opam_repository_tag`` variable.) +Specifically, set it to the hash of your commit on the opam repository MR. Afterwards, you will also need to regenerate the GitLab CI configuration by running ``make -C ci`` from the root of the repository. -- GitLab