doc: standards for project and file names

(From yocto-docs rev: 4e658b0f9552462e9168d8598314ed4ddeee7692)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
2022-05-04 17:25:49 +02:00
committed by Richard Purdie
parent eae7c2a0c2
commit 6a92d985e5

View File

@@ -7,7 +7,29 @@ It is currently a work in progress.
## Text standards
This section has not been filled yet
### 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 names
File names should be quoted as in the below example:
``conf/local.conf``
Using "conf/local/conf" would be wrong.
## ReStructured Text Syntax standards