From mboxrd@z Thu Jan 1 00:00:00 1970 Delivery-date: Wed, 18 Sep 2024 12:04:56 +0200 Received: from metis.whiteo.stw.pengutronix.de ([2a0a:edc0:2:b01:1d::104]) by lore.white.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96) (envelope-from ) id 1sqrYP-005g6a-1D for lore@lore.pengutronix.de; Wed, 18 Sep 2024 12:04:56 +0200 Received: from localhost ([127.0.0.1] helo=metis.whiteo.stw.pengutronix.de) by metis.whiteo.stw.pengutronix.de with esmtp (Exim 4.92) (envelope-from ) id 1sqrYO-0001Xv-GH; Wed, 18 Sep 2024 12:04:56 +0200 Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.whiteo.stw.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1sqrYA-0001Xg-0f; Wed, 18 Sep 2024 12:04:42 +0200 Received: from [2a0a:edc0:0:1101:1d::ac] (helo=dude04.red.stw.pengutronix.de) by drehscheibe.grey.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1sqrY9-008mkC-KS; Wed, 18 Sep 2024 12:04:41 +0200 Received: from rhi by dude04.red.stw.pengutronix.de with local (Exim 4.96) (envelope-from ) id 1sqrY9-001zzU-1r; Wed, 18 Sep 2024 12:04:41 +0200 From: Roland Hieber To: ptxdist@pengutronix.de Date: Wed, 18 Sep 2024 12:04:36 +0200 Message-Id: <20240918100436.476607-1-rhi@pengutronix.de> X-Mailer: git-send-email 2.39.5 MIME-Version: 1.0 Mail-Followup-To: Roland Hieber , ptxdist@pengutronix.de Content-Transfer-Encoding: 8bit Subject: [ptxdist] [PATCH] ptxdist: rename 'export_src' subcommand to 'export-src' X-BeenThere: ptxdist@pengutronix.de X-Mailman-Version: 2.1.29 Precedence: list List-Id: PTXdist Development Mailing List List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: ptxdist@pengutronix.de Cc: Roland Hieber Sender: "ptxdist" X-SA-Exim-Connect-IP: 127.0.0.1 X-SA-Exim-Mail-From: ptxdist-bounces@pengutronix.de X-SA-Exim-Scanned: No (on metis.whiteo.stw.pengutronix.de); SAEximRunCond expanded to false 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 --- 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 [args...] execute in ptxdist environment docs-html generate HTML documentation docs-latex generate LaTeX / PDF documentation - export_src export all source archives needed for this + export-src export all source archives needed for this project to cargosync 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 + $ ptxdist export-src It copies all archives from where are your source archives stored to the path ```` 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 `` build specified make target in PTXdist. -``export_src `` +``export-src `` export all source archives needed for this project to ````. + 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