diff mbox series

doc: standards for project and file names

Message ID 20220504152829.689363-1-michael.opdenacker@bootlin.com
State New
Headers show
Series doc: standards for project and file names | expand

Commit Message

Michael Opdenacker May 4, 2022, 3:28 p.m. UTC 
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/standards.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)
diff mbox series

Patch

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.
 
 ## 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