Yocto Project Documentation
 help / color / mirror / Atom feed
From: "Quentin Schulz" <quentin.schulz@streamunlimited.com>
To: Paul Eggleton <paul.eggleton@linux.microsoft.com>
Cc: docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH 4/5] variables: Add documentation for new kernel-fitimage vars
Date: Tue, 22 Dec 2020 10:39:24 +0100	[thread overview]
Message-ID: <20201222093924.gdmvccls6xd7bme7@qschulz> (raw)
In-Reply-To: <2a491bf195731319b9fa3bca15b95f7ce8342af5.1608598606.git.paul.eggleton@linux.microsoft.com>

Hi Paul,

On Mon, Dec 21, 2020 at 05:06:03PM -0800, Paul Eggleton wrote:
> From: Paul Eggleton <paul.eggleton@microsoft.com>
> 
> Add documentation for FIT_DESC, FIT_SIGN_INDIVIDUAL, UBOOT_MKIMAGE,
> UBOOT_MKIMAGE_SIGN and UBOOT_MKIMAGE_SIGN_ARGS.
> 
> Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
> ---
>  documentation/ref-manual/variables.rst | 33 +++++++++++++++++++++++++++++++++
>  1 file changed, 33 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 8f7f86e..607ebfe 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -2538,6 +2538,14 @@ system and gives an overview of their function and contents.
>        For guidance on how to create your own file permissions settings
>        table file, examine the existing ``fs-perms.txt``.
>  
> +   :term:`FIT_DESC`
> +      Specifies the description string encoded into a fitImage. The default
> +      value is set by the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>`
> +      class as follows:
> +      ::

The two lines above have the same outcome as:

class as follows::

IIRC. I don't remember if a patch was sent by Robert recently nor if it
was merged (does not seem so?) but we strive for consistency on this one
by having all :\n:: migrated to :: at the end of a paragraph.

c.f.: https://lists.yoctoproject.org/g/docs/message/557

Thanks,
Quentin

  reply	other threads:[~2020-12-22  9:39 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-22  1:05 [PATCH 0/5] fitimage-related changes Paul Eggleton
2020-12-22  1:06 ` [PATCH 1/5] classes: minor corrections to kernel-fitimage section Paul Eggleton
2020-12-22  1:06 ` [PATCH 2/5] variables: clarify KERNEL_ALT_IMAGETYPE reference Paul Eggleton
2020-12-22  1:06 ` [PATCH 3/5] variables: explicitly state that UBOOT_MKIMAGE_DTCOPTS is optional Paul Eggleton
2020-12-22  1:06 ` [PATCH 4/5] variables: Add documentation for new kernel-fitimage vars Paul Eggleton
2020-12-22  9:39   ` Quentin Schulz [this message]
2020-12-22 11:40     ` [docs] " Nicolas Dechesne
2020-12-22 11:42       ` Robert P. J. Day
2020-12-22  1:06 ` [PATCH 5/5] ref-manual: use consistent capitalisation of U-Boot Paul Eggleton
2020-12-22  9:41 ` [docs] [PATCH 0/5] fitimage-related changes Quentin Schulz
2020-12-22 10:00   ` Richard Purdie

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201222093924.gdmvccls6xd7bme7@qschulz \
    --to=quentin.schulz@streamunlimited.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=paul.eggleton@linux.microsoft.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox