summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2021-12-06 16:04:01 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-12-13 23:31:34 +0000
commite71983bc7dba65df6273faaad92c5a43afded0ff (patch)
treeb5882d468d58514fdf0e93a24c03fb916be63958 /documentation/kernel-dev
parent99474e0d681cc9beb3604f214884054b3aec38a1 (diff)
downloadpoky-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/kernel-dev')
-rw-r--r--documentation/kernel-dev/advanced.rst6
-rw-r--r--documentation/kernel-dev/concepts-appx.rst4
2 files changed, 5 insertions, 5 deletions
diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst
index 5a6b466ffb..b5290b61b3 100644
--- a/documentation/kernel-dev/advanced.rst
+++ b/documentation/kernel-dev/advanced.rst
@@ -763,7 +763,7 @@ Organizing Your Source
763====================== 763======================
764 764
765Many recipes based on the ``linux-yocto-custom.bb`` recipe use Linux 765Many recipes based on the ``linux-yocto-custom.bb`` recipe use Linux
766kernel sources that have only a single branch - "master". This type of 766kernel sources that have only a single branch. This type of
767repository structure is fine for linear development supporting a single 767repository structure is fine for linear development supporting a single
768machine and architecture. However, if you work with multiple boards and 768machine and architecture. However, if you work with multiple boards and
769architectures, a kernel source repository with multiple branches is more 769architectures, a kernel source repository with multiple branches is more
@@ -772,7 +772,7 @@ board to boot. Sometimes, these patches are works-in-progress or
772fundamentally wrong, yet they are still necessary for specific boards. 772fundamentally wrong, yet they are still necessary for specific boards.
773In these situations, you most likely do not want to include these 773In these situations, you most likely do not want to include these
774patches in every kernel you build (i.e. have the patches as part of the 774patches in every kernel you build (i.e. have the patches as part of the
775lone "master" branch). It is situations like these that give rise to 775default branch). It is situations like these that give rise to
776multiple branches used within a Linux kernel sources Git repository. 776multiple branches used within a Linux kernel sources Git repository.
777 777
778Here are repository organization strategies maximizing source reuse, 778Here are repository organization strategies maximizing source reuse,
@@ -812,7 +812,7 @@ Machine Branches
812When you have multiple machines and architectures to support, or you are 812When you have multiple machines and architectures to support, or you are
813actively working on board support, it is more efficient to create 813actively working on board support, it is more efficient to create
814branches in the repository based on individual machines. Having machine 814branches in the repository based on individual machines. Having machine
815branches allows common source to remain in the "master" branch with any 815branches allows common source to remain in the development branch with any
816features specific to a machine stored in the appropriate machine branch. 816features specific to a machine stored in the appropriate machine branch.
817This organization method frees you from continually reintegrating your 817This organization method frees you from continually reintegrating your
818patches into a feature. 818patches into a feature.
diff --git a/documentation/kernel-dev/concepts-appx.rst b/documentation/kernel-dev/concepts-appx.rst
index cf2e75d853..910318e0f9 100644
--- a/documentation/kernel-dev/concepts-appx.rst
+++ b/documentation/kernel-dev/concepts-appx.rst
@@ -211,8 +211,8 @@ view, there is a linear path that travels from the baseline
211``kernel.org``, through a select group of features and ends with their 211``kernel.org``, through a select group of features and ends with their
212BSP-specific commits. In other words, the divisions of the kernel are 212BSP-specific commits. In other words, the divisions of the kernel are
213transparent and are not relevant to the developer on a day-to-day basis. 213transparent and are not relevant to the developer on a day-to-day basis.
214From the developer's perspective, this path is the "master" branch in 214From the developer's perspective, this path is the development branch.
215Git terms. The developer does not need to be aware of the existence of 215The developer does not need to be aware of the existence of
216any other branches at all. Of course, it can make sense to have these 216any other branches at all. Of course, it can make sense to have these
217branches in the tree, should a person decide to explore them. For 217branches in the tree, should a person decide to explore them. For
218example, a comparison between two BSPs at either the commit level or at 218example, a comparison between two BSPs at either the commit level or at