bartoszek/zephyr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: west: API changes for v1.2

Browse Source 
These are backwards compatible extensions in keeping with
our promise to adhere to semantic versioning from now on.

Signed-off-by: Martí Bolívar <mbolivar@amperecomputing.com>
This commit is contained in:
Martí Bolívar 2023-10-06 11:26:49 -07:00 committed by Carles Cufí
parent 26ca13e30a
commit 41ca16628f
1 changed files with 38 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
doc/develop/west/west-apis.rst
View File

@ -137,14 +137,39 @@ WestCommand
.. automethod:: add_pre_run_hook
.. versionadded:: 1.0.0
.. automethod:: check_call
.. NOTE: the following 'method' (not 'automethod') directives were added for
expediency during the west v1.2 release time frame to work around a build
failure in this zephyr documentation that could not be fixed without
cutting a west point release. (The docstrings in west had some RST syntax
errors).
These should be reverted back to automethod calls at the next release.
.. method:: check_call(args, **kwargs)
Runs ``subprocess.check_call(args, **kwargs)`` after
logging the call at Verbosity.DBG_MORE`` level.
.. versionchanged:: 1.2.0
The *cwd* keyword argument was replaced with a catch-all ``**kwargs``.
.. versionchanged:: 0.11.0
.. automethod:: check_output
.. method:: check_output(args, **kwargs)
Runs ``subprocess.check_output(args, **kwargs)`` after
logging the call at Verbosity.DBG_MORE level.
.. versionchanged:: 1.2.0
The *cwd* keyword argument was replaced with a catch-all ``**kwargs``.
.. versionchanged:: 0.11.0
.. method:: run_subprocess(args, **kwargs)
Runs ``subprocess.run(args, **kwargs)`` after logging
the call at Verbosity.DBG_MORE level.
.. versionadded:: 1.2.0
All subclasses must provide the following abstract methods, which are used
to implement the above:
@ -158,15 +183,23 @@ WestCommand
"quiet" mode for west commands in a future release:
.. automethod:: dbg
.. versionchanged:: 1.2.0
The *end* argument.
.. versionadded:: 1.0.0
.. automethod:: inf
.. versionchanged:: 1.2.0
The *end* argument.
.. versionadded:: 1.0.0
.. automethod:: wrn
.. versionchanged:: 1.2.0
The *end* argument.
.. versionadded:: 1.0.0
.. automethod:: err
.. versionchanged:: 1.2.0
The *end* argument.
.. versionadded:: 1.0.0
.. automethod:: die
@ -413,6 +446,9 @@ Manifest and sub-objects
.. versionadded:: 0.12.0
The *userdata* attribute.
.. versionadded:: 1.2.0
The *description* attribute.
Constructor:
.. automethod:: __init__