From 6a92d985e55f3947e988b71792bb298ed232b7ad Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Wed, 4 May 2022 17:25:49 +0200 Subject: doc: standards for project and file names (From yocto-docs rev: 4e658b0f9552462e9168d8598314ed4ddeee7692) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/standards.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) 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 -- cgit v1.2.3-54-g00ecf