Git commit 1860f30bf92298ead7d355c29ca5e91135d7a0e5 by Joshua Goins, on behalf of Andrew Shark. Committed on 20/11/2023 at 16:03. Pushed by ashark into branch 'docbook_historied_per_file'.
Indicate the existence of --no-stop-on-failure flag BUG: 474263 Original commit: c300de55 https://invent.kde.org/sdk/kdesrc-build/-/commit/c300de55cd6b4519192ab79800d8cf78e0d98bb1 M +4 -10 doc/cmdline/supported-cmdline-params.docbook M +2 -2 doc/getting-started/building-and-troubleshooting.docbook M +2 -2 doc/kdesrc-buildrc/conf-options-table.docbook M +3 -3 doc/using-kdesrc-build/advanced-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/1860f30bf92298ead7d355c29ca5e91135d7a0e5 diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index 71cefc69..79fe89cc 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -423,12 +423,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. @@ -467,14 +461,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> diff --git a/doc/getting-started/building-and-troubleshooting.docbook b/doc/getting-started/building-and-troubleshooting.docbook index 95e3c6db..b9d478eb 100644 --- a/doc/getting-started/building-and-troubleshooting.docbook +++ b/doc/getting-started/building-and-troubleshooting.docbook @@ -39,10 +39,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"> diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 44a1c6b0..cf046afb 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -1076,8 +1076,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> diff --git a/doc/using-kdesrc-build/advanced-features.docbook b/doc/using-kdesrc-build/advanced-features.docbook index f6e56fee..3d9e89c0 100644 --- a/doc/using-kdesrc-build/advanced-features.docbook +++ b/doc/using-kdesrc-build/advanced-features.docbook @@ -193,11 +193,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> @@ -226,7 +226,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.
