diff options
Diffstat (limited to 'documentation/standards.md')
-rw-r--r-- | documentation/standards.md | 24 |
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 | ||
10 | This section has not been filled yet | 10 | ### Project names |
11 | |||
12 | Project names should be capitalized in the same | ||
13 | way they are on Wikipedia, in particular: | ||
14 | |||
15 | * BitBake | ||
16 | * OpenEmbedded | ||
17 | |||
18 | There are exceptions in which such names can be used | ||
19 | in 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 | |||
28 | File names should be quoted as in the below example: | ||
29 | |||
30 | ``conf/local.conf`` | ||
31 | |||
32 | Using "conf/local/conf" would be wrong. | ||
11 | 33 | ||
12 | ## ReStructured Text Syntax standards | 34 | ## ReStructured Text Syntax standards |
13 | 35 | ||