Git commit e5c002cc7030022e71c4c7b7c9770e284879a33d by Johan Ouwerkerk. Committed on 04/01/2020 at 13:27. Pushed by ashark into branch 'docbook_historied_per_file'.
Update documentation to cover CMake generator support. Original commit: 54621a06 https://invent.kde.org/sdk/kdesrc-build/-/commit/54621a068cbab5706178b6033322b4acfb474052 M +1 -1 doc/getting-started/before-building.docbook M +1 -0 doc/index.docbook M +20 -0 doc/kdesrc-buildrc/conf-options-table.docbook https://invent.kde.org/sdk/kdesrc-build/-/commit/e5c002cc7030022e71c4c7b7c9770e284879a33d diff --git a/doc/getting-started/before-building.docbook b/doc/getting-started/before-building.docbook index 16ea996c..dd686f6a 100644 --- a/doc/getting-started/before-building.docbook +++ b/doc/getting-started/before-building.docbook @@ -89,7 +89,7 @@ recommended packages for major distributions</ulink>. <listitem><para>You will need a build tool that actually performs the compilation steps (as generated by &cmake;). GNU Make is recommended and should be available through your package manager. &cmake; does support others options, such -as the "ninja" build tool, which can be used by &kdesrc-build; using the +as the &ninja; build tool, which can be used by &kdesrc-build; using the <link linkend="conf-custom-build-command">custom-build-command</link> configuration file option. </para></listitem> diff --git a/doc/index.docbook b/doc/index.docbook index d9115de7..e74c2e86 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -27,6 +27,7 @@ <!ENTITY git '<application>Git</application>'> <!ENTITY cmake '<application>CMake</application>'> <!ENTITY make '<application>Make</application>'> + <!ENTITY ninja '<application>Ninja</application>'> <!ENTITY ssh '<application>SSH</application>'> <!ENTITY cron '<application>Cron</application>'> <!ENTITY subversion '<application>Subversion</application>'> diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook index 1d0e8ca7..b3ab4420 100644 --- a/doc/kdesrc-buildrc/conf-options-table.docbook +++ b/doc/kdesrc-buildrc/conf-options-table.docbook @@ -226,6 +226,20 @@ operation of the &git; source control system.</para> <para>See <xref linkend="checking-out-parts"/> for an example.</para></entry> </row> +<row id="conf-cmake-generator"> +<entry>cmake-generator</entry> +<entry>Module setting overrides global</entry> +<entry><para>Use this option to specify which generator to use with &cmake;. +Currently both <literal>Ninja</literal> and <literal>Unix Makefiles</literal> +are supported. Invalid (unsupported) values are ignored and treated as if +unset. If not set <literal>Unix Makefiles</literal> will be used by default. +</para> + +<para>Note that if a valid generator is also specified through +<link linkend="conf-cmake-options">cmake-options</link> it will override the +value for <literal>cmake-generator</literal>.</para></entry> +</row> + <row id="conf-cmake-options"> <entry>cmake-options</entry> <entry>Appends to global options for the default buildsystem, overrides global @@ -239,6 +253,12 @@ specify common &cmake; options in the global section.</para> <para>This option does not apply to qt (which does not use &cmake;). Use <link linkend="conf-configure-flags">configure-flags</link> instead.</para> +<para>If a valid generator is specified among the listed options it will +override the value of +<link linkend="conf-cmake-generator">cmake-generator</link>. Invalid +(unsupported) generators are ignored and will not be passed to &cmake;. +</para> + <para>Since these options are passed directly to the &cmake; command line, they should be given as they would be typed into &cmake;. For example:</para>