[sdk/kdesrc-build/docbook_historied_per_file] doc/kdesrc-buildrc: Implement tag and revision options for git modules.

[Michael Pyne]

Git commit 803644c42e94aebbd2c87b075f61e8be10f12f4a by Michael Pyne.
Committed on 22/10/2012 at 03:44.
Pushed by ashark into branch 'docbook_historied_per_file'.

Implement tag and revision options for git modules.

This makes the 'tag' option allow for checking out a given git tag for a
module (which is enforced by using refs/tags/$foo when passing to git).

Additionally, the 'revision' option has been adopted for git modules as
well, to allow for checking out any other git "tree-ish" that git
supports (i.e. anything supported by 'git checkout $foo').

Both options should leave the source directory in a detached HEAD state,
although kdesrc-build will adapt as necessary with each source update.

The auto-stashing is still attempted for both types, and a failure to
apply an auto-stashed change will cause the module to fail to build.
Ensure you're in a clean working directory if you want to avoid issues
due to this.

The test suite continues to pass (not that it's very extensive).

BUG:308493
FIXED-IN:1.16

Original commit: c22b7b06
https://invent.kde.org/sdk/kdesrc-build/-/commit/c22b7b0653ae10fdb04b9991720ac5501c0b79c9

M  +9    -3    doc/kdesrc-buildrc/conf-options-table.docbook

https://invent.kde.org/sdk/kdesrc-build/-/commit/803644c42e94aebbd2c87b075f61e8be10f12f4a

diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook
index ab35e86a..fc43a669 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -715,12 +715,18 @@ specify the &git; repository to download the source code for the module.
 <row id="conf-revision">
 <entry>revision</entry>
 <entry>Module setting overrides global</entry>
-<entry>If this option is set to a value other than 0 (zero), &kdesrc-build;
-will force the &subversion; update to bring the module to the exact revision
+<entry><para>If this option is set to a value other than 0 (zero), &kdesrc-build;
+will force the source update to bring the module to the exact revision
 given, even if options like <link linkend="conf-branch">branch</link> are in
 effect. If the module is already at the given revision then it will not be
 updated further unless this option is changed or removed from the
-configuration.</entry>
+configuration.</para>
+
+<note><para>This option did not work for git-based modules (including <link
+linkend="kde-projects-module-sets">kde-projects</link> modules) until
+&kdesrc-build; version 1.16.</para></note>
+
+</entry>
 </row>
 
 <row id="conf-run-tests">