From 05d54880e47b6e7c7a0bb3220e06e1a6588e3179 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Mon, 15 Apr 2024 11:58:54 +0200 Subject: manuals: standards.md5: add standard for project names Set a new standard to introduce project names with single quotes, so that they appear in generated text with an italic font, to make them easier to distinguish from command names and from ordinary English words. Rework and move the standard for command and file names to make the whole description "flow" better. (From yocto-docs rev: fa6700af56213a5079eaa8d9683f3c2b2fc93740) Signed-off-by: Michael Opdenacker CC: Quentin Schulz Signed-off-by: Richard Purdie --- documentation/standards.md | 33 ++++++++++++++++++--------------- 1 file 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 or reducing readability, as well as for command output which should be kept unmodified. -### Project names +### File, tool and command names -Project names should be capitalized in the same -way they are on Wikipedia, in particular: +File, tool, command and package names should be double tick-quoted. +For example, ``` ``conf/local.conf`` ``` is preferred over +`"conf/local.conf"`. -* BitBake -* OpenEmbedded +### Project names -There are exceptions in which such names can be used -in lower case: +Project names should be introduced with single quotes, to have them rendered +with an italic font and make them easier to distinguish from command names +(double tick-quoted) and from regular English words. -* 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. +An exception is when project names appear in hyperlinks, as nested markup +is not supported by Sphinx yet. -### File, tool and command names +Project names should also be capitalized (or not) in the same way they are on +Wikipedia, or on their own project pages if they are not described on +Wikipedia. If a project name isn't capitalized, it should remain so even +at the beginning of a sentence. -File, tool and command names should be double tick-quoted. -For example, ``` ``conf/local.conf`` ``` is preferred over -`"conf/local.conf"`. +For example: + +* ``` `BitBake` ``` +* ``` `ftrace` ``` ### Variables -- cgit v1.2.3-54-g00ecf