All of lore.kernel.org
 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] doc: document the conventions used in the manual
Date: Mon, 31 Aug 2026 10:26:30 +0200	[thread overview]
Message-ID: <DL2ZIK7TQ8WL.W6B1D1LECK18@bootlin.com> (raw)
In-Reply-To: <20260831031444.4070152-1-twoerner@gmail.com>

Hi,

On Mon Aug 31, 2026 at 5:14 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.

This only adds the document at the bottom of the main page, which I don't think
is a proper place for it. We should either have a section dedicated to this, or
make this a separate document (similar to standards.md in yocto-docs).

I'm leaning towards a separate document (named "standards.md"?), because these
instructions are not related to Bitbake itself. This document should be easily
found though, so perhaps we should mention it in the main README, under the
Contributing section.

Thanks,
Antonin


      reply	other threads:[~2026-08-31  8:26 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-31  3:14 [PATCH] doc: document the conventions used in the manual Trevor Woerner
2026-08-31  8:26 ` 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=DL2ZIK7TQ8WL.W6B1D1LECK18@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 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.