From: Michael Opdenacker <michael.opdenacker@bootlin.com>
To: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Cc: docs@lists.yoctoproject.org
Subject: Re: [RFC][PATCH] manuals: standards.md5: add standard for project names
Date: Mon, 15 Apr 2024 14:40:05 +0200 [thread overview]
Message-ID: <bd7ed6b8-043d-43d0-8e65-43f585dc0725@bootlin.com> (raw)
In-Reply-To: <2f540686-d854-4ff0-88eb-36bd80c1cce8@theobroma-systems.com>
Hello Quentin
On 4/15/24 at 12:35, Quentin Schulz wrote:
> The issue would be the same if a capital letter for the word is
> expected in a sentence. e.g. if a sentence starts with `perf` all
> lowercase, I'm assuming it is the name of some piece of SW. But if the
> sentence starts with Docker, is it the name of a piece of SW or an
> actual word?
>
>> These are the ones that can be harder to distinguish from English
>> words. On the other hand, having all project names (like Docker or
>> Toaster, with the accepted exceptions) styled this way, would make
>> the distinction clearer to readers.
>>
>
> Mmmmm Toaster is a good example of something related to YP that is
> also an English word... I guess all project names highlighted would
> make sense then. We can always try to have some elaborate sed/grep
> command to find Bitbake/bitbake/bitBake instead of BitBake for example
> instead of relying on Vale for it.
Right, good catch. Then let's keep highlighting all project names,
unless somebody else can convince us otherwise.
Cheers
Michael.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
prev parent reply other threads:[~2024-04-15 12:40 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-15 10:05 [RFC][PATCH] manuals: standards.md5: add standard for project names michael.opdenacker
2024-04-15 10:11 ` Quentin Schulz
2024-04-15 10:30 ` Michael Opdenacker
2024-04-15 10:35 ` Quentin Schulz
2024-04-15 12:40 ` Michael Opdenacker [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=bd7ed6b8-043d-43d0-8e65-43f585dc0725@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=quentin.schulz@theobroma-systems.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).