summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-05-04 17:25:49 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-05-10 12:52:35 +0100
commit6a92d985e55f3947e988b71792bb298ed232b7ad (patch)
tree9b71862e911acd774fc3ec5f3d71e3bf0afa4758
parenteae7c2a0c277c764a72073cdce1cdb2eb1fd1b9a (diff)
downloadpoky-6a92d985e55f3947e988b71792bb298ed232b7ad.tar.gz
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>
-rw-r--r--documentation/standards.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/documentation/standards.md b/documentation/standards.md
index a2274f6d6e..d288376828 100644
--- a/documentation/standards.md
+++ b/documentation/standards.md
@@ -7,7 +7,29 @@ It is currently a work in progress.
7 7
8## Text standards 8## Text standards
9 9
10This section has not been filled yet 10### Project names
11
12Project names should be capitalized in the same
13way they are on Wikipedia, in particular:
14
15* BitBake
16* OpenEmbedded
17
18There are exceptions in which such names can be used
19in lower case:
20
21* When referring to a package name
22* When referring to the corresponding command name
23* When used in a cross-reference title. Such
24 titles are usually in lower case.
25
26### File names
27
28File names should be quoted as in the below example:
29
30 ``conf/local.conf``
31
32Using "conf/local/conf" would be wrong.
11 33
12## ReStructured Text Syntax standards 34## ReStructured Text Syntax standards
13 35