Skip to contentSkip to conversation

doc: migration-3.5: variable changes for inclusive language

PATCH Superseded Michael Opdenacker 2 participants 2 messages Mar 16, 2022

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: migration-3.5: variable changes for inclusive language

---
 documentation/migration-guides/migration-3.5.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)
documentation/migration-guides/migration-3.5.rst +11 -0
index da09b6f449..b4816b8171 100644
@@ -7,6 +7,17 @@ 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 variable have been renamed or even
+  deleted. BitBake will stop with an error when renamed or removed variables
+  still exist in your recipes or configuration.
+
+  An :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 warn you about the uses of problematic words such as "blacklist",
+  "whitelist" and "abort".
+
 - 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::
Signature · 1 line
2.25.1
#1 lore raw

Hi Michael,

Quoted 10 lines · Michael Opdenacker via lists.yoctoproject.org
---
  documentation/migration-guides/migration-3.5.rst | 11 +++++++++++
  1 file changed, 11 insertions(+)
documentation/migration-guides/migration-3.5.rst +0 -0
index da09b6f449..b4816b8171 100644

documentation/migration-guides/migration-3.5.rst Project 3.5 Release (codename "kirkstone") from the prior release. · line 11

Quoted 5 lines
documentation/migration-guides/migration-3.5.rst +2 -0
@@ -7,6 +7,17 @@ Project 3.5 Release (codename "kirkstone") from the prior release.
  Recipe changes
  --------------
 
+- To use more `inclusive language <https://urldefense.proofpoint.com/v2/url?u=https-3A__inclusivenaming.org_&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=NZHda3CsbFlho8rTtHcrMeiFe-g4jkzlkRdaW4WJI0MhJ8URYdm4Shoyre2YH9Op&s=6dTdPTNx2AZlcQ8zt1bgh2nA8Ksnbem3BvlytLGcxew&e= >`__
+  in the code and documentation, some variable have been renamed or even

s/variable/variables/

documentation/migration-guides/migration-3.5.rst Project 3.5 Release (codename "kirkstone") from the prior release. · line 18

Quoted 7 lines
documentation/migration-guides/migration-3.5.rst +7 -0
+  deleted. BitBake will stop with an error when renamed or removed variables
+  still exist in your recipes or configuration.
+
+  An :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 warn you about the uses of problematic words such as "blacklist",

s/warn/warns/

s/uses/use/

Maybe we should abstain from mentioning the words that are problematic where we can avoid :) Obviously the list of renamed variables is/will be added below but there's nothing we can do about those.

Cheers,
Quentin

Quoted 16 lines
documentation/migration-guides/migration-3.5.rst +2 -1
+  "whitelist" and "abort".
+
  - 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::
 
 
 
-=-=-=-=-=-=-=-=-=-=-=-

Links: You receive all messages sent to this group.
View/Reply Online (#2609): https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_message_2609&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=NZHda3CsbFlho8rTtHcrMeiFe-g4jkzlkRdaW4WJI0MhJ8URYdm4Shoyre2YH9Op&s=5dxLeJLJCmMjBoayObb6Juk7A9GQ8clUc225eFMwNX8&e=
Mute This Topic: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_mt_89822588_6293953&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=NZHda3CsbFlho8rTtHcrMeiFe-g4jkzlkRdaW4WJI0MhJ8URYdm4Shoyre2YH9Op&s=-odKrM0laseF4Q_3AqUDw4V1ZBGV9YjYQb6Q24Zhrqg&e=
Group Owner: [email protected]
Unsubscribe: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_unsub&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=NZHda3CsbFlho8rTtHcrMeiFe-g4jkzlkRdaW4WJI0MhJ8URYdm4Shoyre2YH9Op&s=k_btoQfWSbNUgUsK02f9kjguOFH8lgOAVZOwb3KBP0Q&e= [[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-