[sdk/kdesrc-build/docbook_historied_per_file] doc: Add git-user option.

Michael Pyne <[email protected]>
Newsgroups gmane.comp.kde.cvs,gmane.comp.kde.doc
Message-ID <[email protected]>
Git commit 7c2665eb90aafece2786217021586042c13ac24e by Michael Pyne.
Committed on 12/09/2015 at 20:57.
Pushed by ashark into branch 'docbook_historied_per_file'.

Add git-user option.

This option can be used to setup the user.name and user.email git-config
options within each new git repository cloned or installed from
snapshot, including kde-projects repositories. This can be useful for
KDE developers with multiple Git identities that they use for
development.

Module settings override global settings so you could e.g. have a global
git-user option for KDE modules and then override specific modules or
module-sets with a different git-user setting.

This setting is only applied during the initial git-clone process
though... if there's interest in having kdesrc-build re-apply settings
later that's possible too.

BUG:352478
FIXED-IN:15.09

Original commit: 21b5eb93
https://invent.kde.org/sdk/kdesrc-build/-/commit/21b5eb9371fbb0f5f43f7cba7606c4bdb32fedd4

M  +2    -2    doc/index.docbook
M  +31   -0    doc/kdesrc-buildrc/conf-options-table.docbook

https://invent.kde.org/sdk/kdesrc-build/-/commit/7c2665eb90aafece2786217021586042c13ac24e

diff --git a/doc/index.docbook b/doc/index.docbook
index cf157d6f..0f3a060a 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -142,8 +142,8 @@
 
 <legalnotice>&FDLNotice;</legalnotice>
 
-<date>2015-03-07</date>
-<releaseinfo>1.16</releaseinfo>
+<date>2015-09-12</date>
+<releaseinfo>15.09</releaseinfo>
 
 <abstract>
 <para>&kdesrc-build; is a script which builds and installs &kde; software
diff --git a/doc/kdesrc-buildrc/conf-options-table.docbook b/doc/kdesrc-buildrc/conf-options-table.docbook
index 48606442..e1980d8d 100644
--- a/doc/kdesrc-buildrc/conf-options-table.docbook
+++ b/doc/kdesrc-buildrc/conf-options-table.docbook
@@ -471,6 +471,37 @@ different module sets.</para></tip>
 </entry>
 </row>
 
+<row id="conf-git-user">
+<entry>git-user</entry>
+<entry>Module setting overrides global</entry>
+<entry>
+<para>This option is intended for &kde; developers. If set, it will be used to
+automatically setup identity information for the &git; source control software
+for <emphasis>newly downloaded</emphasis> &git; modules (including the vast
+majority of &kde; modules).</para>
+
+<para>Specifically, the user's name and email fields for each new &git; repository are filled
+in to the values set by this option.</para>
+
+<para>The value must be specified in the form <option><replaceable>User
+Name</replaceable> &lt;<replaceable>[email protected]</replaceable>&gt;</option>.</para>
+
+<para>
+<informalexample>
+<para>For instance, a developer named <quote>Foo Barbaz</quote> with the
+email address <quote>[email protected]</quote> would use:</para>
+
+<screen>
+    <symbol>git-user</symbol> <replaceable>Foo Barbaz</replaceable> &lt;<replaceable>[email protected]</replaceable>&gt;
+</screen>
+</informalexample>
+</para>
+
+<para>This option was introduced in &kdesrc-build; 15.09.
+</para>
+</entry>
+</row>
+
 <row id="conf-http-proxy">
 <entry>http-proxy</entry>
 <entry>Module setting overrides global</entry>
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.