[v2,RESEND] doc: migration-3.5: variable changes for inclusive language

Message ID 20220317113057.230854-1-michael.opdenacker@bootlin.com
State New
Headers show
Series [v2,RESEND] doc: migration-3.5: variable changes for inclusive language | expand

Commit Message

Michael Opdenacker March 17, 2022, 11:30 a.m. UTC
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/migration-guides/migration-3.5.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

Patch

diff --git a/documentation/migration-guides/migration-3.5.rst b/documentation/migration-guides/migration-3.5.rst
index da09b6f449..6d452a6edf 100644
--- a/documentation/migration-guides/migration-3.5.rst
+++ b/documentation/migration-guides/migration-3.5.rst
@@ -7,6 +7,16 @@  Project 3.5 Release (codename "kirkstone") from the prior release.
 Recipe changes
 --------------
 
+- To use more `inclusive language <https://inclusivenaming.org/>`__
+  in the code and documentation, some variables have been renamed or even
+  deleted. BitBake will stop with an error when renamed or removed variables
+  still exist in your recipes or configuration.
+
+  A :oe_git:`convert-variable-renames.py
+  </openembedded-core/tree/scripts/contrib/convert-variable-renames.py>`
+  script is provided to convert your recipes and configuration,
+  and also warns you about the use of problematic words.
+
 - Because of the uncertainty in future default branch names in git repositories,
   it is now required to add a branch name to all URLs described
   by ``git://`` and ``gitsm://`` :term:`SRC_URI` entries. For example::