From: "Antonin Godard" <antonin.godard@bootlin.com>
To: <twoerner@gmail.com>, <docs@lists.yoctoproject.org>
Subject: Re: [docs] [PATCH] docs: document the conventions used in the manuals
Date: Mon, 31 Aug 2026 10:20:24 +0200 [thread overview]
Message-ID: <DL2ZDVVFILT9.195AJS5FZO23O@bootlin.com> (raw)
In-Reply-To: <DL2ZCLBWUBX3.5ITP3G3AJ0SV@bootlin.com>
On Mon Aug 31, 2026 at 10:18 AM CEST, Antonin Godard wrote:
> Hi,
>
> On Mon Aug 31, 2026 at 5:14 AM CEST, Trevor Woerner via lists.yoctoproject.org wrote:
>> The manuals use angle brackets for placeholders and a prompt to mark a
>> command, and say so nowhere. A reader can only infer both, and one
>> example reads as advice to paste a line that will not parse.
>>
>> Include the new section from every manual, the way the boilerplate is
>> included, so each is self-contained.
>
> We already have a standard.md document that explains these kind of things.
Sorry, s/standard.md/standards.md/.
Antonin
next prev parent reply other threads:[~2026-08-31 8:20 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-08-31 3:14 [PATCH] docs: document the conventions used in the manuals Trevor Woerner
2026-08-31 8:18 ` [docs] " Antonin Godard
2026-08-31 8:20 ` Antonin Godard [this message]
2026-08-31 13:32 ` Trevor Woerner
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=DL2ZDVVFILT9.195AJS5FZO23O@bootlin.com \
--to=antonin.godard@bootlin.com \
--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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.