diff options
Diffstat (limited to 'documentation/standards.md')
-rw-r--r-- | documentation/standards.md | 33 |
1 files changed, 18 insertions, 15 deletions
diff --git a/documentation/standards.md b/documentation/standards.md index e0c0cba83c..bc403e393e 100644 --- a/documentation/standards.md +++ b/documentation/standards.md | |||
@@ -70,27 +70,30 @@ cannot be split without infringing syntactic rules | |||
70 | or reducing readability, as well as for command output | 70 | or reducing readability, as well as for command output |
71 | which should be kept unmodified. | 71 | which should be kept unmodified. |
72 | 72 | ||
73 | ### Project names | 73 | ### File, tool and command names |
74 | 74 | ||
75 | Project names should be capitalized in the same | 75 | File, tool, command and package names should be double tick-quoted. |
76 | way they are on Wikipedia, in particular: | 76 | For example, ``` ``conf/local.conf`` ``` is preferred over |
77 | `"conf/local.conf"`. | ||
77 | 78 | ||
78 | * BitBake | 79 | ### Project names |
79 | * OpenEmbedded | ||
80 | 80 | ||
81 | There are exceptions in which such names can be used | 81 | Project names should be introduced with single quotes, to have them rendered |
82 | in lower case: | 82 | with an italic font and make them easier to distinguish from command names |
83 | (double tick-quoted) and from regular English words. | ||
83 | 84 | ||
84 | * When referring to a package name | 85 | An exception is when project names appear in hyperlinks, as nested markup |
85 | * When referring to the corresponding command name | 86 | is not supported by Sphinx yet. |
86 | * When used in a cross-reference title. Such | ||
87 | titles are usually in lower case. | ||
88 | 87 | ||
89 | ### File, tool and command names | 88 | Project names should also be capitalized (or not) in the same way they are on |
89 | Wikipedia, or on their own project pages if they are not described on | ||
90 | Wikipedia. If a project name isn't capitalized, it should remain so even | ||
91 | at the beginning of a sentence. | ||
90 | 92 | ||
91 | File, tool and command names should be double tick-quoted. | 93 | For example: |
92 | For example, ``` ``conf/local.conf`` ``` is preferred over | 94 | |
93 | `"conf/local.conf"`. | 95 | * ``` `BitBake` ``` |
96 | * ``` `ftrace` ``` | ||
94 | 97 | ||
95 | ### Variables | 98 | ### Variables |
96 | 99 | ||