Re: [docs] [PATCH] manuals: fix name capitalization issues

Re: [docs] [PATCH] manuals: fix name capitalization issues

[Michael Opdenacker]

On 5/4/22 16:29, Michael Opdenacker via lists.yoctoproject.org wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>
> - Using "BitBake" instead of "Bitbake" or "bitbake", aligning with the
>   title of the "BitBake User Manual".
> - Using "OpenEmbedded" instead of "Openembedded"
> - Using "Python" instead of "python"

Apologies for the 3 changes in a single commit.
I was preparing 3 different commits, but a mistake in my git branches
merged them all. I could have fixed that but I preferred to spend my
time in a more productive way...
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH] manuals: fix name capitalization issues

[Quentin Schulz]

Hi Michael,

On 5/4/22 16:29, Michael Opdenacker via lists.yoctoproject.org wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> - Using "BitBake" instead of "Bitbake" or "bitbake", aligning with the
>    title of the "BitBake User Manual".
> - Using "OpenEmbedded" instead of "Openembedded"
> - Using "Python" instead of "python"
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>   documentation/brief-yoctoprojectqs/index.rst       |  4 ++--
>   documentation/conf.py                              |  6 +++---
>   documentation/dev-manual/common-tasks.rst          | 14 +++++++-------
>   documentation/dev-manual/start.rst                 |  2 +-
>   documentation/kernel-dev/common.rst                |  2 +-
>   documentation/kernel-dev/concepts-appx.rst         |  2 +-
>   documentation/migration-guides/migration-2.2.rst   |  2 +-
>   documentation/migration-guides/migration-2.7.rst   |  2 +-
>   documentation/migration-guides/migration-3.0.rst   |  2 +-
>   documentation/migration-guides/migration-3.2.rst   |  4 ++--
>   documentation/migration-guides/migration-3.3.rst   |  4 ++--
>   documentation/migration-guides/migration-3.4.rst   |  2 +-
>   .../migration-guides/release-notes-3.4.1.rst       |  2 +-
>   documentation/profile-manual/usage.rst             |  6 +++---
>   documentation/ref-manual/tasks.rst                 |  2 +-
>   documentation/ref-manual/variables.rst             |  2 +-
>   documentation/sphinx/yocto-vars.py                 |  2 +-
>   documentation/test-manual/intro.rst                |  8 ++++----
>   documentation/toaster-manual/start.rst             |  2 +-
>   documentation/what-i-wish-id-known.rst             |  2 +-
>   20 files changed, 36 insertions(+), 36 deletions(-)
> 
> diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
> index 12cab1db76..7179f25022 100644
> --- a/documentation/brief-yoctoprojectqs/index.rst
> +++ b/documentation/brief-yoctoprojectqs/index.rst
> @@ -424,9 +424,9 @@ information including the website, wiki pages, and user manuals:
>      development documentation, and access to a rich Yocto Project
>      Development Community into which you can tap.
>   
> --  **Video Seminar:** The `Introduction to the Yocto Project and Bitbake, Part 1
> +-  **Video Seminar:** The `Introduction to the Yocto Project and BitBake, Part 1
>      <https://urldefense.proofpoint.com/v2/url?u=https-3A__youtu.be_yuE7my3KOpo&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=3lL8XKUkKw6z-VjGFtkt64aWO9M3tVc5JGfmvS5RcvKRQZ8C7UeVig6yaboueecf&s=_vJVr5l8K81UU7Js_Hv22GZrB1E7TlBepADZuR9GQJ0&e= >`__ and
> -   `Introduction to the Yocto Project and Bitbake, Part 2
> +   `Introduction to the Yocto Project and BitBake, Part 2
>      <https://urldefense.proofpoint.com/v2/url?u=https-3A__youtu.be_iZ05TTyzGHk&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=3lL8XKUkKw6z-VjGFtkt64aWO9M3tVc5JGfmvS5RcvKRQZ8C7UeVig6yaboueecf&s=yCgILuDri4g-Wgrg_st7SOmWyMrTCnY-ocquh1q84dw&e= >`__ videos offer a video seminar
>      introducing you to the most important aspects of developing a
>      custom embedded Linux distribution with the Yocto Project.
> diff --git a/documentation/conf.py b/documentation/conf.py
> index a7cdf415f8..baf550e3e3 100644
> --- a/documentation/conf.py
> +++ b/documentation/conf.py
> @@ -19,7 +19,7 @@ try:
>       import yaml
>   except ImportError:
>       sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\
> -    \nPlease make sure to install pyyaml python package.\n")
> +    \nPlease make sure to install pyyaml Python package.\n")
>       sys.exit(1)
>   
>   # current_version = "dev"
> @@ -108,7 +108,7 @@ extlinks = {
>       'oe_layer': ('https://urldefense.proofpoint.com/v2/url?u=https-3A__layers.openembedded.org_layerindex_branch_master_layer-25s&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=3lL8XKUkKw6z-VjGFtkt64aWO9M3tVc5JGfmvS5RcvKRQZ8C7UeVig6yaboueecf&s=ci0jiBhQiS7rKajQ-7r8Rg6BRSCZV-v-nv4Btg8fRLA&e= ', None),
>   }
>   
> -# Intersphinx config to use cross reference with Bitbake user manual
> +# Intersphinx config to use cross reference with BitBake user manual
>   intersphinx_mapping = {
>       'bitbake': ('https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.yoctoproject.org_bitbake_&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=3lL8XKUkKw6z-VjGFtkt64aWO9M3tVc5JGfmvS5RcvKRQZ8C7UeVig6yaboueecf&s=VheHWvTCqPdNXkAjSKfKoKx9D8TuOKTAK4B_UiK6vNk&e= ' + bitbake_version, None)
>   }
> @@ -129,7 +129,7 @@ try:
>       }
>   except ImportError:
>       sys.stderr.write("The Sphinx sphinx_rtd_theme HTML theme was not found.\
> -    \nPlease make sure to install the sphinx_rtd_theme python package.\n")
> +    \nPlease make sure to install the sphinx_rtd_theme Python package.\n")
>       sys.exit(1)
>   
>   html_logo = 'sphinx-static/YoctoProject_Logo_RGB.jpg'
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index b228c75aab..7108333cdf 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -5392,7 +5392,7 @@ create the properly partitioned image.
>   
>   The ``wic`` command generates partitioned images from existing
>   OpenEmbedded build artifacts. Image generation is driven by partitioning
> -commands contained in an Openembedded kickstart file (``.wks``)
> +commands contained in an OpenEmbedded kickstart file (``.wks``)
>   specified either directly on the command line or as one of a selection
>   of canned kickstart files as shown with the ``wic list images`` command
>   in the
> @@ -5464,7 +5464,7 @@ system needs to meet the following requirements:
>   
>   -  You need to have the build artifacts already available, which
>      typically means that you must have already created an image using the
> -   Openembedded build system (e.g. ``core-image-minimal``). While it
> +   OpenEmbedded build system (e.g. ``core-image-minimal``). While it
>      might seem redundant to generate an image in order to create an image
>      using Wic, the current version of Wic requires the artifacts in the
>      form generated by the OpenEmbedded build system.
> @@ -5546,7 +5546,7 @@ Operational Modes
>   -----------------
>   
>   You can use Wic in two different modes, depending on how much control
> -you need for specifying the Openembedded build artifacts that are used
> +you need for specifying the OpenEmbedded build artifacts that are used
>   for creating the image: Raw and Cooked:
>   
>   -  *Raw Mode:* You explicitly specify build artifacts through Wic
> @@ -9214,7 +9214,7 @@ section:
>      to run specific tasks in the build chain. It can be useful to run
>      tasks "out-of-order" when trying isolate build issues.
>   
> --  ":ref:`dev-manual/common-tasks:general bitbake problems`" describes how
> +-  ":ref:`dev-manual/common-tasks:general BitBake problems`" describes how

I'm wondering if refs are case sensitive? Does it still work?

Cheers,
Quentin