MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 12:59:02 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

manuals: standards.md5: add standard for project names

Browse Source 
Set a new standard to introduce project names with single quotes,
so that they appear in generated text with an italic font,
to make them easier to distinguish from command names and from
ordinary English words.

Rework and move the standard for command and file names
to make the whole description "flow" better.

(From yocto-docs rev: fa6700af56213a5079eaa8d9683f3c2b2fc93740)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker 2024-04-15 11:58:54 +02:00 committed by Richard Purdie
parent 30d5b6f7dd
commit 05d54880e4
1 changed files with 20 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
documentation/standards.md
View File

@ -70,28 +70,31 @@ cannot be split without infringing syntactic rules
or reducing readability, as well as for command output
which should be kept unmodified.
### Project names
Project names should be capitalized in the same
way they are on Wikipedia, in particular:
* BitBake
* OpenEmbedded
There are exceptions in which such names can be used
in lower case:
* When referring to a package name
* When referring to the corresponding command name
* When used in a cross-reference title. Such
titles are usually in lower case.
### File, tool and command names
File, tool and command names should be double tick-quoted.
File, tool, command and package names should be double tick-quoted.
For example, ``` ``conf/local.conf`` ``` is preferred over
`"conf/local.conf"`.
### Project names
Project names should be introduced with single quotes, to have them rendered
with an italic font and make them easier to distinguish from command names
(double tick-quoted) and from regular English words.
An exception is when project names appear in hyperlinks, as nested markup
is not supported by Sphinx yet.
Project names should also be capitalized (or not) in the same way they are on
Wikipedia, or on their own project pages if they are not described on
Wikipedia. If a project name isn't capitalized, it should remain so even
at the beginning of a sentence.
For example:
* ``` `BitBake` ```
* ``` `ftrace` ```
### Variables
Every variable should be mentioned with: