diff options
author | Quentin Schulz <foss@0leil.net> | 2021-12-06 16:04:01 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-12-13 23:31:34 +0000 |
commit | e71983bc7dba65df6273faaad92c5a43afded0ff (patch) | |
tree | b5882d468d58514fdf0e93a24c03fb916be63958 /documentation/overview-manual | |
parent | 99474e0d681cc9beb3604f214884054b3aec38a1 (diff) | |
download | poky-e71983bc7dba65df6273faaad92c5a43afded0ff.tar.gz |
make the documentation a bit more inclusive
Except the name of variables which can't be changed only in the
documentation for obvious reasons and workflow or developement
explanations around the use of the "master" branch which cannot be
replaced with "development" branch instead, most of the non-inclusive
words that appear in https://inclusivenaming.org/word-lists/tier-1/
should have been replaced in this patch.
(From yocto-docs rev: 2755f35060084f7af356091de9dc144f85530fe2)
Signed-off-by: Quentin Schulz <foss+yocto@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual')
-rw-r--r-- | documentation/overview-manual/concepts.rst | 10 | ||||
-rw-r--r-- | documentation/overview-manual/development-environment.rst | 45 | ||||
-rw-r--r-- | documentation/overview-manual/yp-intro.rst | 2 |
3 files changed, 24 insertions, 33 deletions
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 33b4071026..bfd54208af 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
@@ -1718,7 +1718,7 @@ inputs still exits - items already built and present in the | |||
1718 | :term:`Build Directory`. The checksum (or | 1718 | :term:`Build Directory`. The checksum (or |
1719 | signature) for a particular task needs to add the hashes of all the | 1719 | signature) for a particular task needs to add the hashes of all the |
1720 | tasks on which the particular task depends. Choosing which dependencies | 1720 | tasks on which the particular task depends. Choosing which dependencies |
1721 | to add is a policy decision. However, the effect is to generate a master | 1721 | to add is a policy decision. However, the effect is to generate a |
1722 | checksum that combines the basehash and the hashes of the task's | 1722 | checksum that combines the basehash and the hashes of the task's |
1723 | dependencies. | 1723 | dependencies. |
1724 | 1724 | ||
@@ -1735,12 +1735,8 @@ included in any checksum):: | |||
1735 | PRSERV_DUMPDIR PRSERV_DUMPFILE PRSERV_LOCKDOWN PARALLEL_MAKE \\ | 1735 | PRSERV_DUMPDIR PRSERV_DUMPFILE PRSERV_LOCKDOWN PARALLEL_MAKE \\ |
1736 | CCACHE_DIR EXTERNAL_TOOLCHAIN CCACHE CCACHE_DISABLE LICENSE_PATH SDKPKGSUFFIX" | 1736 | CCACHE_DIR EXTERNAL_TOOLCHAIN CCACHE CCACHE_DISABLE LICENSE_PATH SDKPKGSUFFIX" |
1737 | 1737 | ||
1738 | The | 1738 | The previous example does not include :term:`WORKDIR` since that variable is |
1739 | previous example excludes | 1739 | actually constructed as a path within :term:`TMPDIR`, which is included above. |
1740 | :term:`WORKDIR` since that variable | ||
1741 | is actually constructed as a path within | ||
1742 | :term:`TMPDIR`, which is on the | ||
1743 | whitelist. | ||
1744 | 1740 | ||
1745 | The rules for deciding which hashes of dependent tasks to include | 1741 | The rules for deciding which hashes of dependent tasks to include |
1746 | through dependency chains are more complex and are generally | 1742 | through dependency chains are more complex and are generally |
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index d719ba69eb..fc193f3135 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst | |||
@@ -163,9 +163,9 @@ these tarballs gives you a snapshot of the released files. | |||
163 | 163 | ||
164 | - Be sure to always work in matching branches for both the selected | 164 | - Be sure to always work in matching branches for both the selected |
165 | BSP repository and the Source Directory (i.e. ``poky``) | 165 | BSP repository and the Source Directory (i.e. ``poky``) |
166 | repository. For example, if you have checked out the "master" | 166 | repository. For example, if you have checked out the "&DISTRO_NAME_NO_CAP;" |
167 | branch of ``poky`` and you are going to use ``meta-intel``, be | 167 | branch of ``poky`` and you are going to use ``meta-intel``, be |
168 | sure to checkout the "master" branch of ``meta-intel``. | 168 | sure to checkout the "&DISTRO_NAME_NO_CAP;" branch of ``meta-intel``. |
169 | 169 | ||
170 | In summary, here is where you can get the project files needed for | 170 | In summary, here is where you can get the project files needed for |
171 | development: | 171 | development: |
@@ -233,8 +233,8 @@ all diverging functionality. Although there is no need to use Git, many | |||
233 | open source projects do so. | 233 | open source projects do so. |
234 | 234 | ||
235 | For the Yocto Project, a key individual called the "maintainer" is | 235 | For the Yocto Project, a key individual called the "maintainer" is |
236 | responsible for the integrity of the "master" branch of a given Git | 236 | responsible for the integrity of the development branch of a given Git |
237 | repository. The "master" branch is the "upstream" repository from which | 237 | repository. The development branch is the "upstream" repository from which |
238 | final or most recent builds of a project occur. The maintainer is | 238 | final or most recent builds of a project occur. The maintainer is |
239 | responsible for accepting changes from other developers and for | 239 | responsible for accepting changes from other developers and for |
240 | organizing the underlying branch structure to reflect release strategies | 240 | organizing the underlying branch structure to reflect release strategies |
@@ -279,8 +279,8 @@ submitting patches and changes, see the | |||
279 | ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" | 279 | ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" |
280 | section in the Yocto Project Development Tasks Manual. | 280 | section in the Yocto Project Development Tasks Manual. |
281 | 281 | ||
282 | In summary, there is a single point of entry for changes into a "master" | 282 | In summary, there is a single point of entry for changes into the |
283 | or development branch of the Git repository, which is controlled by the | 283 | development branch of the Git repository, which is controlled by the |
284 | project's maintainer. A set of developers independently | 284 | project's maintainer. A set of developers independently |
285 | develop, test, and submit changes to "contrib" areas for the maintainer | 285 | develop, test, and submit changes to "contrib" areas for the maintainer |
286 | to examine. The maintainer then chooses which changes are going to | 286 | to examine. The maintainer then chooses which changes are going to |
@@ -311,7 +311,7 @@ Book <https://book.git-scm.com>`__. | |||
311 | host. You can name these branches anything you like. It is helpful to | 311 | host. You can name these branches anything you like. It is helpful to |
312 | give them names associated with the particular feature or change on | 312 | give them names associated with the particular feature or change on |
313 | which you are working. Once you are done with a feature or change and | 313 | which you are working. Once you are done with a feature or change and |
314 | have merged it into your local master branch, simply discard the | 314 | have merged it into your local development branch, simply discard the |
315 | temporary branch. | 315 | temporary branch. |
316 | 316 | ||
317 | - *Merge Changes:* The ``git merge`` command allows you to take the | 317 | - *Merge Changes:* The ``git merge`` command allows you to take the |
@@ -348,7 +348,7 @@ Book <https://book.git-scm.com>`__. | |||
348 | 348 | ||
349 | - *Patch Workflow:* This workflow allows you to notify the maintainer | 349 | - *Patch Workflow:* This workflow allows you to notify the maintainer |
350 | through an email that you have a change (or patch) you would like | 350 | through an email that you have a change (or patch) you would like |
351 | considered for the "master" branch of the Git repository. To send | 351 | considered for the development branch of the Git repository. To send |
352 | this type of change, you format the patch and then send the email | 352 | this type of change, you format the patch and then send the email |
353 | using the Git commands ``git format-patch`` and ``git send-email``. | 353 | using the Git commands ``git format-patch`` and ``git send-email``. |
354 | For information on how to use these scripts, see the | 354 | For information on how to use these scripts, see the |
@@ -433,17 +433,12 @@ development branch in the repository. To help illustrate, consider the | |||
433 | following example Git commands:: | 433 | following example Git commands:: |
434 | 434 | ||
435 | $ cd ~ | 435 | $ cd ~ |
436 | $ git clone git://git.yoctoproject.org/poky | 436 | $ git clone git://git.yoctoproject.org/poky -b &DISTRO_NAME_NO_CAP; |
437 | $ cd poky | ||
438 | $ git checkout -b &DISTRO_NAME_NO_CAP; origin/&DISTRO_NAME_NO_CAP; | ||
439 | 437 | ||
440 | In the previous example | 438 | In the previous example |
441 | after moving to the home directory, the ``git clone`` command creates a | 439 | after moving to the home directory, the ``git clone`` command creates a |
442 | local copy of the upstream ``poky`` Git repository. By default, Git | 440 | local copy of the upstream ``poky`` Git repository and checks out a |
443 | checks out the "master" branch for your work. After changing the working | 441 | local branch named "&DISTRO_NAME_NO_CAP;", which tracks the upstream |
444 | directory to the new local repository (i.e. ``poky``), the | ||
445 | ``git checkout`` command creates and checks out a local branch named | ||
446 | "&DISTRO_NAME_NO_CAP;", which tracks the upstream | ||
447 | "origin/&DISTRO_NAME_NO_CAP;" branch. Changes you make while in this | 442 | "origin/&DISTRO_NAME_NO_CAP;" branch. Changes you make while in this |
448 | branch would ultimately affect the upstream "&DISTRO_NAME_NO_CAP;" branch | 443 | branch would ultimately affect the upstream "&DISTRO_NAME_NO_CAP;" branch |
449 | of the ``poky`` repository. | 444 | of the ``poky`` repository. |
@@ -558,9 +553,9 @@ descriptions and strategies on how to use these commands: | |||
558 | - *git pull --rebase:* Retrieves information from an upstream Git | 553 | - *git pull --rebase:* Retrieves information from an upstream Git |
559 | repository and places it in your local Git repository. You use this | 554 | repository and places it in your local Git repository. You use this |
560 | command to make sure you are synchronized with the repository from | 555 | command to make sure you are synchronized with the repository from |
561 | which you are basing changes (.e.g. the "master" branch). The | 556 | which you are basing changes (e.g. the "&DISTRO_NAME_NO_CAP;" |
562 | "--rebase" option ensures that any local commits you have in your | 557 | branch). The "--rebase" option ensures that any local commits you |
563 | branch are preserved at the top of your local branch. | 558 | have in your branch are preserved at the top of your local branch. |
564 | 559 | ||
565 | - *git push repo-name local-branch:upstream-branch:* Sends | 560 | - *git push repo-name local-branch:upstream-branch:* Sends |
566 | all your committed local changes to the upstream Git repository that | 561 | all your committed local changes to the upstream Git repository that |
@@ -571,13 +566,13 @@ descriptions and strategies on how to use these commands: | |||
571 | 566 | ||
572 | - *git merge:* Combines or adds changes from one local branch of | 567 | - *git merge:* Combines or adds changes from one local branch of |
573 | your repository with another branch. When you create a local Git | 568 | your repository with another branch. When you create a local Git |
574 | repository, the default branch is named "master". A typical workflow | 569 | repository, the default branch may be named "main". A typical |
575 | is to create a temporary branch that is based off "master" that you | 570 | workflow is to create a temporary branch that is based off "main" |
576 | would use for isolated work. You would make your changes in that | 571 | that you would use for isolated work. You would make your changes in |
577 | isolated branch, stage and commit them locally, switch to the | 572 | that isolated branch, stage and commit them locally, switch to the |
578 | "master" branch, and then use the ``git merge`` command to apply the | 573 | "main" branch, and then use the ``git merge`` command to apply the |
579 | changes from your isolated branch into the currently checked out | 574 | changes from your isolated branch into the currently checked out |
580 | branch (e.g. "master"). After the merge is complete and if you are | 575 | branch (e.g. "main"). After the merge is complete and if you are |
581 | done with working in that isolated branch, you can safely delete the | 576 | done with working in that isolated branch, you can safely delete the |
582 | isolated branch. | 577 | isolated branch. |
583 | 578 | ||
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 7aee9db04f..a8ca9e9440 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst | |||
@@ -371,7 +371,7 @@ Yocto Project: | |||
371 | 371 | ||
372 | - *AutoBuilder:* AutoBuilder is a project that automates build tests | 372 | - *AutoBuilder:* AutoBuilder is a project that automates build tests |
373 | and quality assurance (QA). By using the public AutoBuilder, anyone | 373 | and quality assurance (QA). By using the public AutoBuilder, anyone |
374 | can determine the status of the current "master" branch of Poky. | 374 | can determine the status of the current development branch of Poky. |
375 | 375 | ||
376 | .. note:: | 376 | .. note:: |
377 | 377 | ||