diff --git a/docs/alpha/michelson.rst b/docs/alpha/michelson.rst index 0b9240a8cb990e33838272edc0116514bd4e15cf..77a3b8cc11e5a78e64d6ce13ad9fa7e07b72738c 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/developer/contributing-adding-a-new-opam-dependency.rst b/docs/developer/contributing-adding-a-new-opam-dependency.rst index 38fcb1a9359b3f383f2fd732dc78afb78aaba559..ce26e50596a3cc4543b1cfd98c28b1c5ebc5e8b0 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. diff --git a/docs/introduction/howtorun.rst b/docs/introduction/howtorun.rst index 41108db7b2178fc7c764c4dde2580c972c45e319..7bcaba269cf88a80075b7a78822f9a2dc1d1e938 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 ~~~~~~~ diff --git a/docs/releases/version-20.rst b/docs/releases/version-20.rst index c94fd23205be23be84bb956fea7c4550cde045fe..19264adb8591315487af00451616340e50b3ef5d 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 diff --git a/docs/shell/smart_rollup_node.rst b/docs/shell/smart_rollup_node.rst index fbc2bf30023b4a02392f55b5c17286ee4f1b3641..6dde2cb434aef34640be7ef0f4fad9aefce4ef70 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" : } @@ -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