Git commit c300de55cd6b4519192ab79800d8cf78e0d98bb1 by Joshua Goins, on behalf of Andrew Shark. Committed on 20/11/2023 at 17:03. Pushed by redstrate into branch 'master'.
Indicate the existence of --no-stop-on-failure flag BUG: 474263 M +1 -5 README.md M +1 -1 completions/zsh/_kdesrc-build M +2 -2 doc/README.md M +11 -17 doc/index.docbook M +3 -8 doc/man-kdesrc-build.1.docbook M +0 -2 modules/ksb/Cmdline.pm https://invent.kde.org/sdk/kdesrc-build/-/commit/c300de55cd6b4519192ab79800d8cf78e0d98bb1 diff --git a/README.md b/README.md index cb5f024e..4b6fb180 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ built, you can move onto the next step. ```shell $ cd ~/kde/src/kdesrc-build -$ ./kdesrc-build --stop-on-failure dolphin +$ ./kdesrc-build dolphin ``` This will build [Dolphin](https://www.kde.org/applications/system/dolphin/), @@ -137,10 +137,6 @@ For each module built, kdesrc-build will complete these steps: - Perform the build, if needed - Install the module -The `--stop-on-failure` flag causes kdesrc-build to stop the first time a -module fails to build, in case there are missing dependencies. If not set, -kdesrc-build would otherwise try to build all the modules even if some fail. - Hopefully everything will go well the first time, and kdesrc-build will be able to download and build all of the modules that you ask for. :) diff --git a/completions/zsh/_kdesrc-build b/completions/zsh/_kdesrc-build index b160fb2c..1c28bffe 100644 --- a/completions/zsh/_kdesrc-build +++ b/completions/zsh/_kdesrc-build @@ -21,7 +21,7 @@ _arguments \ '(--resume-from --resume-after)'{--resume-from=,--resume-after=}'[Skips modules until just before or after the given package, then operates as normal]:::_kdesrc-build_modules' \ '(--stop-before --stop-after)'{--stop-before=,--stop-after=}'[Stops just before or after the given package is reached]:::_kdesrc-build_modules' \ '(--include-dependencies --no-include-dependencies)'{--include-dependencies,--no-include-dependencies}'[Builds/Skip KDE-based dependencies]' \ - '--stop-on-failure[Stops the build as soon as a package fails to build]' \ + '(--stop-on-failure --no-stop-on-failure)'{--stop-on-failure,--no-stop-on-failure}'[Stops/Does not stop the build as soon as a package fails to build]' \ \ '(--quiet -q)'{--quiet,-q}'[Do not be as noisy with the output.]' \ '--really-quiet[Only output warnings and errors.]' \ diff --git a/doc/README.md b/doc/README.md index ff2a487b..984ab378 100644 --- a/doc/README.md +++ b/doc/README.md @@ -80,8 +80,8 @@ but for now they're at least worth nothing here: is particularly useful when a silly local error breaks an important module and several dozen dependent modules. -- Alternately, you can use the `--stop-on-failure` command-line option (and - there's a corresponding configuration file option) to have kdesrc-build abort +- Use the `--no-stop-on-failure` command-line option (or + the corresponding configuration file option) to make kdesrc-build not abort after the first module fails to build. - Either way if you're running kdesrc-build frequently as part of a diff --git a/doc/index.docbook b/doc/index.docbook index fd83f081..c1305c7f 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -583,10 +583,10 @@ linkend="cmdline-pretend">--pretend</link></option> command line option.</para> to actually running the script.</para> <screen> - <prompt>%</prompt> <userinput><command>kdesrc-build</command> <option>--stop-on-failure</option></userinput> + <prompt>%</prompt> <userinput><command>kdesrc-build</command></userinput> </screen> -<para>This command will download the appropriate source code, and build and install each module in order, but will stop if a module fails to build (due to the <option>--stop-on-failure</option> option). Afterwards, you should see output similar to that in <xref +<para>This command will download the appropriate source code, build and install each module in order. Afterwards, you should see output similar to that in <xref linkend="example-build-sequence"/>:</para> <example id="example-build-sequence"> @@ -2818,8 +2818,8 @@ linkend="ssh-agent-reminder"/>.</para> <row id="conf-stop-on-failure"> <entry>stop-on-failure</entry> <entry>Module setting overrides global</entry> -<entry>Set this option value to <userinput>true</userinput> to cause the script to stop execution -after an error occurs during the build or install process. This option is true by default. +<entry>Setting this option to <userinput>false</userinput> allows the script to continue execution +after an error occurs during the build or install process. Default value is <literal>true</literal>. </entry> </row> @@ -3455,12 +3455,6 @@ building the modules you were building before, without fiddling with <option><link linkend="cmdline-resume-from">--resume-from</link></option> and <option><link linkend="cmdline-stop-before">--stop-before</link></option>. -</para><para> -This is even handier with the <option><link -linkend="cmdline-stop-on-failure">--stop-on-failure</link></option> command -line argument, especially if you're initially setting up your development -environment. - </para><para> This option was added with &kdesrc-build; 1.16. @@ -3499,14 +3493,14 @@ This command line option was added with &kdesrc-build; 1.16. <varlistentry id="cmdline-stop-on-failure"> <term><parameter>--stop-on-failure</parameter></term> +<term><parameter>--no-stop-on-failure</parameter></term> <listitem><para> -This option causes the build to abort as soon as a failure occurs. Useful when -you're setting up your initial development environment. Without this flag, -&kdesrc-build; will try to press on with the rest of the modules in the build +This option controls if the build will be aborted as soon as a failure occurs. +Default behavior is --stop-on-failure. You may override it if you wish to press on with the rest of the modules in the build, to avoid wasting time in case the problem is with a single module. </para><para> This option was added with &kdesrc-build; 1.16. See also the -<link linkend="conf-stop-on-failure">stop-on-failure</link> option. +<link linkend="conf-stop-on-failure">stop-on-failure</link> configuration file option. </para></listitem> </varlistentry> @@ -4167,11 +4161,11 @@ successfully built the modules in the list. </sect3> <sect3 id="stop-on-failure-stops-early"> -<title>Stopping early with --stop-on-failure</title> +<title>Not stopping early with --no-stop-on-failure</title> <para> The primary method to do this is to use the -<link linkend="cmdline-stop-on-failure">--stop-on-failure</link> +<link linkend="cmdline-stop-on-failure">--no-stop-on-failure</link> command line option when you run &kdesrc-build;. </para> @@ -4200,7 +4194,7 @@ installing a module.</para> </sect3> <sect3 id="stopping-early-without-stop-on-failure"> -<title>Stopping &kdesrc-build; early without --stop-on-failure</title> +<title>Stopping &kdesrc-build; gracefully when stop-on-failure is false</title> <para>As mentioned above, it is possible to cause &kdesrc-build; to gracefully shutdown early once it has completed the module it is currently working on. diff --git a/doc/man-kdesrc-build.1.docbook b/doc/man-kdesrc-build.1.docbook index 0c1f38ef..8ef987a9 100644 --- a/doc/man-kdesrc-build.1.docbook +++ b/doc/man-kdesrc-build.1.docbook @@ -404,11 +404,6 @@ combining short options into one at this point. (E.g. running without fiddling with <option>--resume-from</option> and <option>--stop-before</option>. </para> - -<para> - This is even handier with the <option>--stop-on-failure</option> option, - especially if you're initially setting up your development environment. -</para> </listitem> </varlistentry> @@ -529,13 +524,13 @@ combining short options into one at this point. (E.g. running <varlistentry> <term> -<option>--stop-on-failure</option> +<option>--stop-on-failure, --no-stop-on-failure</option> </term> <listitem> <para> - This option causes the build to abort as soon as a failure occurs. Useful when you're setting - up your initial development environment. Without this flag, <command>kdesrc-build</command> + This option causes the build to abort as soon as a failure occurs. This is the default. + With negative flag, <command>kdesrc-build</command> will try to press on with the rest of the modules in the build to avoid wasting time in case the problem is with a single module. </para> diff --git a/modules/ksb/Cmdline.pm b/modules/ksb/Cmdline.pm index 483393d5..6403a596 100644 --- a/modules/ksb/Cmdline.pm +++ b/modules/ksb/Cmdline.pm @@ -386,8 +386,6 @@ sub _showHelpAndExit -d Also builds KDE-based dependencies of given modules. (This is enabled by default; use --no-include-dependencies or -D to disable) - --stop-on-failure Stops the build as soon as a package fails to build. - More docs at https://docs.kde.org/?application=kdesrc-build Supported configuration options: https://docs.kde.org/trunk5/en/kdesrc-build/kdesrc-build/conf-options-table.html Supported cmdline options: https://docs.kde.org/trunk5/en/kdesrc-build/kdesrc-build/cmdline.html