Skip to content

Commit 069afbe

Browse files
nordicjmstephanosio
authored andcommitted
doc: release-notes 3.3: Add note on python argument parser change
Adds a note that python command line argument abbreviations have been disabled, are no longer allowed in future and instructions of how to update out-of-tree scripts that used abbreviated arguments. Signed-off-by: Jamie McCrae <[email protected]>
1 parent d72e135 commit 069afbe

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/releases/release-notes-3.3.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,17 @@ Changes in this release
9191
* :kconfig:option:`CONFIG_NETWORKING`
9292
* :kconfig:option:`CONFIG_NET_UDP`
9393

94+
* Python's argparse argument parser usage in Zephyr scripts has been updated
95+
to disable abbreviations, any future python scripts or python code updates
96+
must also disable allowing abbreviations by using ``allow_abbrev=False``
97+
when setting up ``ArgumentParser()``.
98+
99+
This may cause out-of-tree scripts or commands to fail if they have relied
100+
upon their behaviour previously, these will need to be updated in order for
101+
building to work. As an example, if a script argument had ``--reset-type``
102+
and an out-of-tree script used this by passing ``--reset`` then it will need
103+
to be updated to use the full argument name, ``--reset-type``.
104+
94105
Removed APIs in this release
95106
============================
96107

0 commit comments

Comments
 (0)