From d9adf28c10d4a28538e2f90b97dd8949f28815a6 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Tue, 29 Mar 2022 08:46:15 +0200 Subject: manuals: replace hyphens with em dashes Fix some hyphens being improperly used as em dashes. See https://www.grammarly.com/blog/hyphens-and-dashes/ Using em dashes may also allow Sphinx to hyphenate and break lines in the best way. Note that the first character after an em dash not supposed to be capitalized, unless a specific rule applies, typically when what follows is a proper noun. Fix a few misuses of parentheses in following text. (From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/sdk-manual/extensible.rst | 6 +++--- documentation/sdk-manual/working-projects.rst | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) (limited to 'documentation/sdk-manual') diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst index 6bb262273d..ed9e43a2d8 100644 --- a/documentation/sdk-manual/extensible.rst +++ b/documentation/sdk-manual/extensible.rst @@ -252,7 +252,7 @@ command: - *Left*: The left scenario in the figure represents a common situation where the source code does not exist locally and needs to be extracted. In this situation, the source code is extracted - to the default workspace - you do not want the files in some + to the default workspace --- you do not want the files in some specific location outside of the workspace. Thus, everything you need will be located in the workspace:: @@ -267,7 +267,7 @@ command: - *Middle*: The middle scenario in the figure also represents a situation where the source code does not exist locally. In this case, the code is again upstream and needs to be extracted to some - local area - this time outside of the default workspace. + local area --- this time outside of the default workspace. .. note:: @@ -302,7 +302,7 @@ command: recipe for the code and places the recipe into the workspace. Because the extracted source code already exists, ``devtool`` does - not try to relocate the source code into the workspace - only the + not try to relocate the source code into the workspace --- only the new recipe is placed in the workspace. Aside from a recipe folder, the command also creates an associated diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst index efef5c8bd2..7f8d9b8491 100644 --- a/documentation/sdk-manual/working-projects.rst +++ b/documentation/sdk-manual/working-projects.rst @@ -174,19 +174,19 @@ variables and Makefile variables during development. The main point of this section is to explain the following three cases regarding variable behavior: -- *Case 1 - No Variables Set in the Makefile Map to Equivalent +- *Case 1 --- No Variables Set in the Makefile Map to Equivalent Environment Variables Set in the SDK Setup Script:* Because matching variables are not specifically set in the ``Makefile``, the variables retain their values based on the environment setup script. -- *Case 2 - Variables Are Set in the Makefile that Map to Equivalent +- *Case 2 --- Variables Are Set in the Makefile that Map to Equivalent Environment Variables from the SDK Setup Script:* Specifically setting matching variables in the ``Makefile`` during the build results in the environment settings of the variables being overwritten. In this case, the variables you set in the ``Makefile`` are used. -- *Case 3 - Variables Are Set Using the Command Line that Map to +- *Case 3 --- Variables Are Set Using the Command Line that Map to Equivalent Environment Variables from the SDK Setup Script:* Executing the ``Makefile`` from the command line results in the environment variables being overwritten. In this case, the -- cgit v1.2.3-54-g00ecf