diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2024-02-09 17:48:06 +0100 |
---|---|---|
committer | Steve Sakoman <steve@sakoman.com> | 2024-03-01 05:19:54 -1000 |
commit | fa870dfd0fd760ec1ab0342f5c82851c043f3eaf (patch) | |
tree | c6993e569b3e007213425a31a1aff8761c413dfc /documentation/migration-guides | |
parent | 74ebddb9219e02cd300630a550353560768ed77e (diff) | |
download | poky-fa870dfd0fd760ec1ab0342f5c82851c043f3eaf.tar.gz |
manuals: suppress excess use of "following" word
To simplify the style, replace "Following is" and "Following are"
by "here is" and "here are", sounding more natural.
In some cases, also go further by simplifying "Here are/is xxx"
by "xxx are/is" when the "are" or "is" are not two far at
the end of the sentence.
In some cases too, completely remove the sentence, when
it's redundant with the preceding title.
(From yocto-docs rev: 2539f1b9cbf9bdd40eff93c6522dc76133debed7)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Daniel Ammann <daniel.ammann@bytesatwork.ch>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation/migration-guides')
-rw-r--r-- | documentation/migration-guides/migration-1.5.rst | 6 | ||||
-rw-r--r-- | documentation/migration-guides/migration-2.2.rst | 16 | ||||
-rw-r--r-- | documentation/migration-guides/migration-2.4.rst | 8 | ||||
-rw-r--r-- | documentation/migration-guides/migration-2.5.rst | 8 | ||||
-rw-r--r-- | documentation/migration-guides/migration-4.0.rst | 2 |
5 files changed, 10 insertions, 30 deletions
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst index 6affe68b58..81a434d5b7 100644 --- a/documentation/migration-guides/migration-1.5.rst +++ b/documentation/migration-guides/migration-1.5.rst | |||
@@ -252,7 +252,7 @@ section in the Yocto Project Development Tasks Manual. | |||
252 | Build History | 252 | Build History |
253 | ------------- | 253 | ------------- |
254 | 254 | ||
255 | Following are changes to Build History: | 255 | The changes to Build History are: |
256 | 256 | ||
257 | - Installed package sizes: ``installed-package-sizes.txt`` for an image | 257 | - Installed package sizes: ``installed-package-sizes.txt`` for an image |
258 | now records the size of the files installed by each package instead | 258 | now records the size of the files installed by each package instead |
@@ -275,7 +275,7 @@ section in the Yocto Project Development Tasks Manual. | |||
275 | ``udev`` | 275 | ``udev`` |
276 | -------- | 276 | -------- |
277 | 277 | ||
278 | Following are changes to ``udev``: | 278 | The changes to ``udev`` are: |
279 | 279 | ||
280 | - ``udev`` no longer brings in ``udev-extraconf`` automatically through | 280 | - ``udev`` no longer brings in ``udev-extraconf`` automatically through |
281 | :term:`RRECOMMENDS`, since this was originally | 281 | :term:`RRECOMMENDS`, since this was originally |
@@ -319,7 +319,7 @@ Removed and Renamed Recipes | |||
319 | Other Changes | 319 | Other Changes |
320 | ------------- | 320 | ------------- |
321 | 321 | ||
322 | Following is a list of short entries describing other changes: | 322 | Here is a list of short entries describing other changes: |
323 | 323 | ||
324 | - ``run-postinsts``: Make this generic. | 324 | - ``run-postinsts``: Make this generic. |
325 | 325 | ||
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst index 40e3b5cb2b..49cd9b9ae0 100644 --- a/documentation/migration-guides/migration-2.2.rst +++ b/documentation/migration-guides/migration-2.2.rst | |||
@@ -70,9 +70,9 @@ Metadata Must Now Use Python 3 Syntax | |||
70 | 70 | ||
71 | The metadata is now required to use Python 3 syntax. For help preparing | 71 | The metadata is now required to use Python 3 syntax. For help preparing |
72 | metadata, see any of the many Python 3 porting guides available. | 72 | metadata, see any of the many Python 3 porting guides available. |
73 | Alternatively, you can reference the conversion commits for Bitbake and | 73 | Alternatively, you can reference the conversion commits for BitBake and |
74 | you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes. Following are | 74 | you can use :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes. |
75 | particular areas of interest: | 75 | Particular areas of interest are: |
76 | 76 | ||
77 | - subprocess command-line pipes needing locale decoding | 77 | - subprocess command-line pipes needing locale decoding |
78 | 78 | ||
@@ -181,14 +181,8 @@ root filesystem, provides an image, and uses the ``nographic`` option:: | |||
181 | 181 | ||
182 | $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic | 182 | $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic |
183 | 183 | ||
184 | Following is a list of variables that can be set in configuration files | 184 | Here is a list of variables that can be set in configuration files |
185 | such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``: | 185 | such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``:: |
186 | |||
187 | .. note:: | ||
188 | |||
189 | "QB" means "QEMU Boot". | ||
190 | |||
191 | :: | ||
192 | 186 | ||
193 | QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386") | 187 | QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386") |
194 | QB_OPT_APPEND: Options to append to QEMU (e.g. "-show-cursor") | 188 | QB_OPT_APPEND: Options to append to QEMU (e.g. "-show-cursor") |
diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst index 964ed92937..66dfc20d95 100644 --- a/documentation/migration-guides/migration-2.4.rst +++ b/documentation/migration-guides/migration-2.4.rst | |||
@@ -89,8 +89,6 @@ occurred: | |||
89 | Removed Recipes | 89 | Removed Recipes |
90 | --------------- | 90 | --------------- |
91 | 91 | ||
92 | The following recipes have been removed: | ||
93 | |||
94 | - ``acpitests``: This recipe is not maintained. | 92 | - ``acpitests``: This recipe is not maintained. |
95 | 93 | ||
96 | - ``autogen-native``: No longer required by Grub, oe-core, or | 94 | - ``autogen-native``: No longer required by Grub, oe-core, or |
@@ -213,8 +211,6 @@ recipes you might have. This will avoid breakage in post 2.4 releases. | |||
213 | Package QA Changes | 211 | Package QA Changes |
214 | ------------------ | 212 | ------------------ |
215 | 213 | ||
216 | The following package QA changes took place: | ||
217 | |||
218 | - The "unsafe-references-in-scripts" QA check has been removed. | 214 | - The "unsafe-references-in-scripts" QA check has been removed. |
219 | 215 | ||
220 | - If you refer to ``${COREBASE}/LICENSE`` within | 216 | - If you refer to ``${COREBASE}/LICENSE`` within |
@@ -229,8 +225,6 @@ The following package QA changes took place: | |||
229 | ``README`` File Changes | 225 | ``README`` File Changes |
230 | ----------------------- | 226 | ----------------------- |
231 | 227 | ||
232 | The following are changes to ``README`` files: | ||
233 | |||
234 | - The main Poky ``README`` file has been moved to the ``meta-poky`` | 228 | - The main Poky ``README`` file has been moved to the ``meta-poky`` |
235 | layer and has been renamed ``README.poky``. A symlink has been | 229 | layer and has been renamed ``README.poky``. A symlink has been |
236 | created so that references to the old location work. | 230 | created so that references to the old location work. |
@@ -246,8 +240,6 @@ The following are changes to ``README`` files: | |||
246 | Miscellaneous Changes | 240 | Miscellaneous Changes |
247 | --------------------- | 241 | --------------------- |
248 | 242 | ||
249 | The following are additional changes: | ||
250 | |||
251 | - The ``ROOTFS_PKGMANAGE_BOOTSTRAP`` variable and any references to it | 243 | - The ``ROOTFS_PKGMANAGE_BOOTSTRAP`` variable and any references to it |
252 | have been removed. You should remove this variable from any custom | 244 | have been removed. You should remove this variable from any custom |
253 | recipes. | 245 | recipes. |
diff --git a/documentation/migration-guides/migration-2.5.rst b/documentation/migration-guides/migration-2.5.rst index fdbf2f3da3..03ecb16dc6 100644 --- a/documentation/migration-guides/migration-2.5.rst +++ b/documentation/migration-guides/migration-2.5.rst | |||
@@ -85,8 +85,6 @@ The following recipes have been removed: | |||
85 | Scripts and Tools Changes | 85 | Scripts and Tools Changes |
86 | ------------------------- | 86 | ------------------------- |
87 | 87 | ||
88 | The following are changes to scripts and tools: | ||
89 | |||
90 | - ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer``: The | 88 | - ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer``: The |
91 | ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer`` scripts | 89 | ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer`` scripts |
92 | previously shipped with poky but not in OpenEmbedded-Core have been | 90 | previously shipped with poky but not in OpenEmbedded-Core have been |
@@ -117,8 +115,6 @@ The following are changes to scripts and tools: | |||
117 | BitBake Changes | 115 | BitBake Changes |
118 | --------------- | 116 | --------------- |
119 | 117 | ||
120 | The following are BitBake changes: | ||
121 | |||
122 | - The ``--runall`` option has changed. There are two different | 118 | - The ``--runall`` option has changed. There are two different |
123 | behaviors people might want: | 119 | behaviors people might want: |
124 | 120 | ||
@@ -151,7 +147,7 @@ The following are BitBake changes: | |||
151 | Python and Python 3 Changes | 147 | Python and Python 3 Changes |
152 | --------------------------- | 148 | --------------------------- |
153 | 149 | ||
154 | The following are auto-packaging changes to Python and Python 3: | 150 | Here are auto-packaging changes to Python and Python 3: |
155 | 151 | ||
156 | The script-managed ``python-*-manifest.inc`` files that were previously | 152 | The script-managed ``python-*-manifest.inc`` files that were previously |
157 | used to generate Python and Python 3 packages have been replaced with a | 153 | used to generate Python and Python 3 packages have been replaced with a |
@@ -185,8 +181,6 @@ change please see :yocto_git:`this commit | |||
185 | Miscellaneous Changes | 181 | Miscellaneous Changes |
186 | --------------------- | 182 | --------------------- |
187 | 183 | ||
188 | The following are additional changes: | ||
189 | |||
190 | - The :ref:`kernel <ref-classes-kernel>` class supports building packages for multiple kernels. | 184 | - The :ref:`kernel <ref-classes-kernel>` class supports building packages for multiple kernels. |
191 | If your kernel recipe or ``.bbappend`` file mentions packaging at | 185 | If your kernel recipe or ``.bbappend`` file mentions packaging at |
192 | all, you should replace references to the kernel in package names | 186 | all, you should replace references to the kernel in package names |
diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst index fc801144b1..9e78fc709f 100644 --- a/documentation/migration-guides/migration-4.0.rst +++ b/documentation/migration-guides/migration-4.0.rst | |||
@@ -140,7 +140,7 @@ Python changes | |||
140 | classes should be updated to inherit ``setuptools*`` equivalents instead. | 140 | classes should be updated to inherit ``setuptools*`` equivalents instead. |
141 | 141 | ||
142 | - The Python package build process is now based on `wheels <https://pythonwheels.com/>`__. | 142 | - The Python package build process is now based on `wheels <https://pythonwheels.com/>`__. |
143 | Here are the new Python packaging classes that should be used: | 143 | The new Python packaging classes that should be used are |
144 | :ref:`python_flit_core <ref-classes-python_flit_core>`, | 144 | :ref:`python_flit_core <ref-classes-python_flit_core>`, |
145 | :ref:`python_setuptools_build_meta <ref-classes-python_setuptools_build_meta>` | 145 | :ref:`python_setuptools_build_meta <ref-classes-python_setuptools_build_meta>` |
146 | and :ref:`python_poetry_core <ref-classes-python_poetry_core>`. | 146 | and :ref:`python_poetry_core <ref-classes-python_poetry_core>`. |