Git commit 3b8afbfadb585cf18e54de5749b3ece1f195b82d by Michael Pyne. Committed on 07/09/2011 at 20:48. Pushed by ashark into branch 'docbook_historied_per_file'.
GIT_SILENT doc: Minor tag usage cleanups Original commit: 24158198 https://invent.kde.org/sdk/kdesrc-build/-/commit/241581982a5d92f07af4e3c2248b7d3e564db36c M +2 -2 doc/cmdline/supported-cmdline-params.docbook M +11 -11 doc/kdesrc-buildrc/conf-options-table.docbook M +8 -8 doc/using-kdesrc-build/advanced-features.docbook M +1 -1 doc/using-kdesrc-build/developer-features.docbook M +1 -1 doc/using-kdesrc-build/other-features.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/3b8afbfadb585cf18e54de5749b3ece1f195b82d diff --git a/doc/cmdline/supported-cmdline-params.docbook b/doc/cmdline/supported-cmdline-params.docbook index cbf3599c..2c435608 100644 --- a/doc/cmdline/supported-cmdline-params.docbook +++ b/doc/cmdline/supported-cmdline-params.docbook @@ -223,7 +223,7 @@ specify other module names on the command line. <note><para>This option formerly added <link linkend="cmdline-no-src"><parameter>--no-src</parameter></link>, but does not any longer (since &kdesrc-build; 1.13). If you want to avoid source updates -when resuming, simply pass <option><replaceable>--no-src</replaceable></option> +when resuming, simply pass <option><userinput>--no-src</userinput></option> in addition to the other options. </para></note> @@ -244,7 +244,7 @@ specify other module names on the command line. <note><para>This option formerly added <link linkend="cmdline-no-src"><parameter>--no-src</parameter></link>, but does not any longer (since &kdesrc-build; 1.13). If you want to avoid source updates -when resuming, simply pass <option><replaceable>--no-src</replaceable></option> +when resuming, simply pass <option><userinput>--no-src</userinput></option> in addition to the other options. </para></note> diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 224db878..1734ae23 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -59,7 +59,7 @@ linkend="conf-repository">repository</link> option.</entry> <entry><para>This option enables the asynchronous mode of operation, where the source code update and the build process will be performed in parallel, instead of waiting for all of the source code updates before starting the build process. This option defaults -to enabling asynchronous mode. To disable, set this option to <replaceable>false</replaceable></para> +to enabling asynchronous mode. To disable, set this option to <userinput>false</userinput></para> <para>This option is available since the 1.6 release.</para></entry> </row> @@ -131,13 +131,13 @@ Perhaps surprisingly, this option can be changed per module. tries to build a module that has not had any source code updates.</para> <para>By setting <option>build-when-unchanged</option> to -<replaceable>true</replaceable>, &kdesrc-build; always attempts the build phase +<userinput>true</userinput>, &kdesrc-build; always attempts the build phase for a module, even if the module did not have any source code updates. This is the default setting since it is more likely to lead to a correct build.</para> <para>By setting <option>build-when-unchanged</option> to -<replaceable>false</replaceable>, &kdesrc-build; will only attempt to run the +<userinput>false</userinput>, &kdesrc-build; will only attempt to run the build phase for a module if the module has a source code update, or in other situations where it is likely that a rebuild is actually required. This can save time, especially if you run &kdesrc-build; daily, or more frequently.</para> @@ -192,7 +192,7 @@ are set for you automatically)</para></entry> <row id="conf-colorful-output"> <entry>colorful-output</entry> <entry>Cannot be overridden</entry> -<entry>Set this option to <replaceable>false</replaceable> to disable the colorful output of &kdesrc-build;. +<entry>Set this option to <userinput>false</userinput> to disable the colorful output of &kdesrc-build;. This option defaults to <replaceable>true</replaceable>. Note that &kdesrc-build; will not output the color codes to anything but a terminal (such as xterm, &konsole;, or the normal &Linux; console). @@ -250,7 +250,7 @@ or directory separators in the name as this will interfere with any make sure that if you are using ssh-agent, it is actually managing some &ssh; identities. This is to try and prevent &ssh; from asking for your pass phrase for every module. You can disable this check by setting -<option>disable-agent-check</option> to <replaceable>true</replaceable>. +<option>disable-agent-check</option> to <userinput>true</userinput>. </entry> </row> @@ -363,7 +363,7 @@ different module sets.</para></tip> <entry>Module setting overrides global</entry> <entry>This option is used to install the package after it successfully builds. This option is enabled by default. If you want to disable this, you need to set -this option to <replaceable>false</replaceable> in the <link +this option to <userinput>false</userinput> in the <link linkend="configure-data">configuration file</link>. You can also use the <link linkend="cmdline-no-install"><option>--no-install</option></link> command line flag. @@ -446,7 +446,7 @@ systems with more than one processor core. <row id="conf-manual-build"> <entry>manual-build</entry> <entry>Module setting overrides global</entry> -<entry>Set the option value to <replaceable>true</replaceable> to keep the +<entry>Set the option value to <userinput>true</userinput> to keep the build process from attempting to build this module. It will still be kept up-to-date when updating from &subversion;. This option is exactly equivalent to the <link linkend="cmdline-no-build"><option>--no-build</option></link> @@ -457,7 +457,7 @@ command line option. <row id="conf-manual-update"> <entry>manual-update</entry> <entry>Module setting overrides global</entry> -<entry>Set the option value to <replaceable>true</replaceable> to keep the +<entry>Set the option value to <userinput>true</userinput> to keep the build process from attempting to update (and by extension, build or install) this module. If you set this option for a module, then you have essentially commented it out. @@ -598,7 +598,7 @@ configuration.</entry> <row id="conf-run-tests"> <entry>run-tests</entry> <entry>Module setting overrides global</entry> -<entry>If set to <replaceable>true</replaceable>, then the module will be +<entry>If set to <userinput>true</userinput>, then the module will be built with support for running its test suite, and the test suite will be executed as part of the build process. &kdesrc-build; will show a simple report of the test results. This is useful for developers or those who want @@ -633,7 +633,7 @@ to represent the home directory if using this option. <row id="conf-stop-on-failure"> <entry>stop-on-failure</entry> <entry>Module setting overrides global</entry> -<entry>Set this option value to <replaceable>true</replaceable> to cause the script to stop execution +<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 off by default. </entry> @@ -676,7 +676,7 @@ require &cmake;, and &cmake; use is not permitted on any other modules. to be used for disk and other I/O usage, which can significantly improve the responsiveness of the rest of the system at the expense of slightly longer running times for &kdesrc-build;. The default is to be disabled, to enable -the lower disk priority set this to <replaceable>true</replaceable>. +the lower disk priority set this to <userinput>true</userinput>. </entry> </row> diff --git a/doc/using-kdesrc-build/advanced-features.docbook b/doc/using-kdesrc-build/advanced-features.docbook index 77b49c54..a2068400 100644 --- a/doc/using-kdesrc-build/advanced-features.docbook +++ b/doc/using-kdesrc-build/advanced-features.docbook @@ -281,8 +281,8 @@ If you change the setting of the &build-dir; option, then use that instead of <informalexample> <para>Rebuild using <filename>.refresh-me</filename> for module <replaceable>kdelibs</replaceable>:</para> <screen> -<prompt>%</prompt> <userinput><command>touch</command> <filename class="directory">~/kdesrc/build/<replaceable>kdelibs</replaceable>.refresh-me</filename></userinput> -<prompt>%</prompt> <userinput><command>kdesrc-build</command></userinput> +<prompt>%</prompt> <userinput><command>touch</command> <filename>~/kdesrc/build/<replaceable>kdelibs</replaceable>/.refresh-me</filename></userinput> +<prompt>%</prompt> <userinput><command>kdesrc-build</command></userinput> </screen> </informalexample> </sect3> @@ -329,14 +329,14 @@ if you canceled a build run in the middle. You can control this using the <note><para>Older versions of &kdesrc-build; would skip the source update when resuming a build. This is no longer done by default, but you can always use -the <option><replaceable>--no-src</replaceable></option> command line option +the <option>--no-src</option> command line option to skip the source update.</para></note> <informalexample> <para>Resuming the build starting from kdebase:</para> <screen> -<prompt>%</prompt> <userinput><command>kdesrc-build</command> <option>--resume-from=<replaceable>kdebase</replaceable></option></userinput> +<prompt>%</prompt> <userinput><command>kdesrc-build</command> <option>--resume-from=<replaceable>kdebase</replaceable></option></userinput> </screen> </informalexample> @@ -345,7 +345,7 @@ to skip the source update.</para></note> the issue and installed the module yourself):</para> <screen> -<prompt>%</prompt> <userinput><command>kdesrc-build</command> <option>--resume-after=<replaceable>kdebase</replaceable></option></userinput> +<prompt>%</prompt> <userinput><command>kdesrc-build</command> <option>--resume-after=<replaceable>kdebase</replaceable></option></userinput> </screen> </informalexample> @@ -365,7 +365,7 @@ performing the update and build.</para> <informalexample> <para>Ignoring extragear/multimedia and kdereview during a full run:</para> <screen> -<prompt>%</prompt> <userinput><command>kdesrc-build</command> <option>--ignore-modules</option> <replaceable>extragear/multimedia kdereview</replaceable></userinput> +<prompt>%</prompt> <userinput><command>kdesrc-build</command> <option>--ignore-modules</option> <replaceable>extragear/multimedia kdereview</replaceable></userinput> </screen> </informalexample> @@ -394,7 +394,7 @@ any setting from the configuration file.</para> testing:</para> <screen> -<prompt>%</prompt> <userinput><command>kdesrc-build</command> <option>--pretend</option> <option>--<replaceable>source-dir</replaceable>=<replaceable>/dev/null</replaceable></option></userinput> +<prompt>%</prompt> <userinput><command>kdesrc-build</command> <option>--pretend</option> <option>--<replaceable>source-dir</replaceable>=<replaceable>/dev/null</replaceable></option></userinput> </screen> </informalexample> @@ -414,7 +414,7 @@ syntax is similar: --<replaceable>module</replaceable>,<replaceable>option-name< <para>Using a different build directory for the kdeedu module:</para> <screen> -<prompt>%</prompt> <userinput><command>kdesrc-build</command> <option>--<replaceable>kdeedu</replaceable>,<replaceable>build-dir</replaceable>=<replaceable>temp-build</replaceable></option></userinput> +<prompt>%</prompt> <userinput><command>kdesrc-build</command> <option>--<replaceable>kdeedu</replaceable>,<replaceable>build-dir</replaceable>=<replaceable>temp-build</replaceable></option></userinput> </screen> </informalexample> diff --git a/doc/using-kdesrc-build/developer-features.docbook b/doc/using-kdesrc-build/developer-features.docbook index cbe86744..c7b51177 100644 --- a/doc/using-kdesrc-build/developer-features.docbook +++ b/doc/using-kdesrc-build/developer-features.docbook @@ -19,7 +19,7 @@ handle passwords for the second possible protocol for &kde; developers, https. <para>You may wish to disable the &ssh; Agent check, in case of situations where &kdesrc-build; is mis-detecting the presence of an agent. To disable the agent check, set the <option>disable-agent-check</option> option to -<replaceable>true</replaceable>.</para> +<userinput>true</userinput>.</para> <informalexample> <para>Disabling the &ssh; agent check:</para> diff --git a/doc/using-kdesrc-build/other-features.docbook b/doc/using-kdesrc-build/other-features.docbook index c5c44cd3..02f8e209 100644 --- a/doc/using-kdesrc-build/other-features.docbook +++ b/doc/using-kdesrc-build/other-features.docbook @@ -35,7 +35,7 @@ will normally display with colorized text.</para> <para>You can disable this by using the <option>--no-color</option> on the command line, or by setting the &colorful-output; option in the <link linkend="configure-data">configuration file</link> to -<replaceable>false</replaceable>. +<userinput>false</userinput>. </para> <informalexample>
