summaryrefslogtreecommitdiff
path: root/docs/develop
diff options
context:
space:
mode:
authorJeff Epler <jepler@unpythonic.net>2025-09-21 09:50:02 -0500
committerDamien George <damien@micropython.org>2025-09-26 14:36:59 +1000
commit70c4ffa77081385df6401be80d5b2e640a2ca976 (patch)
tree3821e05d84fc21d11e53dc2f8b6a54235795977b /docs/develop
parent293bb0e575052c29aeeae0ea53a41eb1c1a88db8 (diff)
tools/ci.sh: Add `--bash-completion` option.
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
Diffstat (limited to 'docs/develop')
-rw-r--r--docs/develop/gettingstarted.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/develop/gettingstarted.rst b/docs/develop/gettingstarted.rst
index b625a72c9..4cc818fda 100644
--- a/docs/develop/gettingstarted.rst
+++ b/docs/develop/gettingstarted.rst
@@ -306,6 +306,22 @@ As an example, you can build and test the unix minimal port with:
$ tools/ci.sh unix_minimal_build unix_minimal_run_tests
+If you use the bash shell, you can add a ``ci`` command with tab completion:
+
+.. code-block:: bash
+
+ $ eval `tools/ci.sh --bash-completion`
+ $ ci unix_cov<tab>
+
+This will complete the ci step name to ``unix_coverage_``.
+Pressing tab a second time will show the list of matching steps:
+
+.. code-block:: bash
+
+ $ ci unix_coverage_<tab>
+ unix_coverage_32bit_build
+ unix_coverage_32bit_run_native_mpy_tests…
+
Folder structure
----------------