Yocto Project Documentation
 help / color / mirror / Atom feed
From: "Antonin Godard" <antonin.godard@bootlin.com>
To: <twoerner@gmail.com>, <docs@lists.yoctoproject.org>
Cc: <bitbake-devel@lists.openembedded.org>
Subject: Re: [docs] [PATCH v2] doc: document the conventions used in the manual
Date: Tue, 22 Sep 2026 10:11:10 +0200	[thread overview]
Message-ID: <DLLOYSTZ6OMD.LKRDMZZLZRB8@bootlin.com> (raw)
In-Reply-To: <20260922015519.313312-1-twoerner@gmail.com>

On Tue Sep 22, 2026 at 3:55 AM CEST, Trevor Woerner via lists.yoctoproject.org wrote:
> The manual uses angle brackets for placeholders and a prompt to mark a
> command, and says so nowhere. A reader can only infer both.
>
> Add a page stating them, in the sidebar beside the other top-level
> entries, so it is reachable from any page of the manual.

A similar patch was sent to yocto-docs[1]. Let's hold off this one until the
definitive version in yocto-docs is merged, please.

[1]: https://lore.kernel.org/r/20260922013912.55583-1-twoerner@gmail.com

Thanks,
Antonin


      reply	other threads:[~2026-09-22  8:11 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-22  1:55 [PATCH v2] doc: document the conventions used in the manual Trevor Woerner
2026-09-22  8:11 ` Antonin Godard [this message]

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=DLLOYSTZ6OMD.LKRDMZZLZRB8@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=bitbake-devel@lists.openembedded.org \
    --cc=docs@lists.yoctoproject.org \
    --cc=twoerner@gmail.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