Git commit edc4c2b17ec35a321a6460189a01e6ed869c64e6 by Andrew Shark. Committed on 05/01/2024 at 19:59. Pushed by ashark into branch 'master'.
doc: developer-features - separate docbook A +33 -0 doc/developer-features.docbook M +2 -33 doc/index.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/edc4c2b17ec35a321a6460189a01e6ed869c64e6 diff --git a/doc/developer-features.docbook b/doc/developer-features.docbook new file mode 100644 index 00000000..1a5dc69a --- /dev/null +++ b/doc/developer-features.docbook @@ -0,0 +1,33 @@ +<sect1 id="developer-features"> +<title>Features for &kde; developers</title> + +<sect2 id="ssh-agent-reminder"> +<title>&ssh; Agent checks</title> +<para>&kdesrc-build; can ensure that &kde; developers that use &ssh; to +access the &kde; source repository do not accidentally forget to leave the +&ssh; Agent tool enabled. This can cause &kdesrc-build; to hang indefinitely +waiting for the developer to type in their &ssh; password, +so by default &kdesrc-build; will check if the Agent is running before +performing source updates. +</para> + +<note><para>This is only done for &kde; developers using &ssh;. +</para></note> + +<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 +<userinput>true</userinput>.</para> + +<informalexample> +<para>Disabling the &ssh; agent check:</para> +<screen> +global + disable-agent-check true +end global +</screen> +</informalexample> + +</sect2> + +</sect1> diff --git a/doc/index.docbook b/doc/index.docbook index 4e6f9d31..2e8306bb 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -77,6 +77,7 @@ <!ENTITY conf-options-table SYSTEM "conf-options-table.docbook"> <!ENTITY configure-data SYSTEM "configure-data.docbook"> <!ENTITY credits-and-license SYSTEM "credits-and-license.docbook"> + <!ENTITY developer-features SYSTEM "developer-features.docbook"> ]> <book id="kdesrc-build" lang="&language;"> @@ -1466,39 +1467,7 @@ do with this tool.</para> &advanced-features; -<sect1 id="developer-features"> -<title>Features for &kde; developers</title> - -<sect2 id="ssh-agent-reminder"> -<title>&ssh; Agent checks</title> -<para>&kdesrc-build; can ensure that &kde; developers that use &ssh; to -access the &kde; source repository do not accidentally forget to leave the -&ssh; Agent tool enabled. This can cause &kdesrc-build; to hang indefinitely -waiting for the developer to type in their &ssh; password, -so by default &kdesrc-build; will check if the Agent is running before -performing source updates. -</para> - -<note><para>This is only done for &kde; developers using &ssh;. -</para></note> - -<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 -<userinput>true</userinput>.</para> - -<informalexample> -<para>Disabling the &ssh; agent check:</para> -<screen> -global - disable-agent-check true -end global -</screen> -</informalexample> - -</sect2> - -</sect1> +&developer-features; <sect1 id="other-features"> <title>Other &kdesrc-build; features</title>