[ptxdist] [PATCH] ptxdist: rename 'export_src' subcommand to 'export-src'

[ptxdist] [PATCH] ptxdist: rename 'export_src' subcommand to 'export-src'

[Roland Hieber]

All other subcommands have dashes between words, so prefer it here too.
Accept the old syntax with underscore for backwards compatibility.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 bin/ptxdist             | 4 ++--
 doc/daily_work.inc      | 6 +++---
 doc/faq.rst             | 2 +-
 doc/ref_parameter.rst   | 4 +++-
 scripts/bash_completion | 2 +-
 5 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/bin/ptxdist b/bin/ptxdist
index 6d6de64d8fbd..e65d1d01f42a 100755
--- a/bin/ptxdist
+++ b/bin/ptxdist
@@ -807,7 +807,7 @@ Misc:
   bash <cmd> [args...]		execute <cmd> in ptxdist environment
   docs-html			generate HTML documentation
   docs-latex			generate LaTeX / PDF documentation
-  export_src <target dir>	export all source archives needed for this
+  export-src <target dir>	export all source archives needed for this
 				project to <target dir>
   cargosync <pkg>		create or update the rule file for the cargo package
 				dependencies
@@ -1824,7 +1824,7 @@ EOF
 			create_docs "${cmd#docs-}" &&
 			exit
 			;;
-		export_src)
+		export_src|export-src)
 			if [ -z "${1}" ]; then
 				echo
 				echo "${PTXDIST_LOG_PROMPT}error: Please specify a target directory."
diff --git a/doc/daily_work.inc b/doc/daily_work.inc
index b98adf75197d..331d19e285ef 100644
--- a/doc/daily_work.inc
+++ b/doc/daily_work.inc
@@ -865,11 +865,11 @@ Sometimes it makes sense to get all required source archives at once.
 For example prior to a shipment we want to also include all source
 archives, to free the user from downloading it by him/herself.
 
-PTXdist supports this requirement by the ``export_src`` parameter. It
+PTXdist supports this requirement by the ``export-src`` parameter. It
 collects all required source archives into one given single directory.
 To do so, the current project must be set up correctly, e.g. the
 ``select`` and ``platform`` commands must be ran prior the
-``export_src`` step.
+``export-src`` step.
 
 If everything is set up correctly we can run the following commands to
 get the full list of required archives to build the project again
@@ -878,7 +878,7 @@ without an internet connection.
 .. code-block:: text
 
     $ mkdir my_archives
-    $ ptxdist export_src my_archives
+    $ ptxdist export-src my_archives
 
 PTXdist will now collect all source archives to the ``my_archives/``
 directory.
diff --git a/doc/faq.rst b/doc/faq.rst
index f85f6e33615a..9a7580799abd 100644
--- a/doc/faq.rst
+++ b/doc/faq.rst
@@ -71,7 +71,7 @@ Answer:
   First build your PTXdist project completely and then run the
   following command::
 
-      $ ptxdist export_src <archive directory>
+      $ ptxdist export-src <archive directory>
 
   It copies all archives from where are your source archives stored to
   the path ``<archive directory>`` which can be on your backup media.
diff --git a/doc/ref_parameter.rst b/doc/ref_parameter.rst
index dd71046bb5a9..8f8f6cab7b04 100644
--- a/doc/ref_parameter.rst
+++ b/doc/ref_parameter.rst
@@ -303,9 +303,11 @@ Misc Actions
 ``make <target>``
   build specified make target in PTXdist.
 
-``export_src <target-dir>``
+``export-src <target-dir>``
   export all source archives needed for this project to ``<target-dir>``.
 
+  For backwards compatibility, the old syntax ``export_src`` is still accepted.
+
 ``docs-html``
   build HTML documentation for a BSP. The output is written to
   Documentation/html/index.html
diff --git a/scripts/bash_completion b/scripts/bash_completion
index 3d57d974bad7..4bff2d4b6f85 100644
--- a/scripts/bash_completion
+++ b/scripts/bash_completion
@@ -114,7 +114,7 @@ _ptxdist_completion()
 	clone)
 		[ ${#args[@]} -lt 2 ] && _filedir -d
 		;;
-	toolchain|export_src)
+	toolchain|export_src|export-src)
 		[ ${#args[@]} -lt 1 ] && _filedir -d
 		;;
 	select|platform|collection|gdb)
-- 
2.39.5