[PATCH] Documentation/config.txt: Add git-gui options

[PATCH] Documentation/config.txt: Add git-gui options

[Gustaf Hendeby]

The 'git gui' has a number of options that can be specified using the
options dialog. Sometimes it is convenient to be able to specify these
from the command line, therefor document these options.

Signed-off-by: Gustaf Hendeby <hendeby@isy.liu.se>
---

This manual update was initiated by the problem with git gui freezing
up at start when only aspell previous to version 0.6 is available.
For the moment a fix is to set gui.spellingdictionary="none", however
this option isn't documented anywhere but in code.  I think it would
be nice to have this option and other used by git gui documented
somewhere, even if for no other reason than to understand what is in
your .gitconfig.

This patch introduces some more of the git gui specific options in
config.txt with the reset of the git options (as suggested by Shawn.).
An option would be to put the documentation in git-gui.txt and link to
there from config.txt.  This way the config documentation does get
less cluttered, and it makes it possible to have different
documentation for different versions of git gui.  Does anyone have any
opinions?  Maybe it is only me that think the options needs to be
documented at?

/Gustaf


 Documentation/config.txt |   31 +++++++++++++++++++++++++++++++
 1 files changed, 31 insertions(+), 0 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index fe43b12..06ab05e 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -673,6 +673,37 @@ specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
 is one of "ext" and "pserver") to make them apply only for the given
 access method.
 
+gui.commitmsgwidth::
+	Defines how wide the commit message window is in the
+	linkgit:git-gui[1]. "75" is the default.
+
+gui.diffcontext::
+	Specify how many context lines should be used by in calls to
+	diff made in the linkgit:git-gui[1]. The default is "5".
+
+gui.matchtrackingbranch::
+	Determine if new branches created with linkgit:git-gui[1] should
+	default to track remote branches with matching names. Default:
+	"false".
+
+gui.newbranchtemplate::
+	Is used as suggested name when creating new branches using the
+	linkgit:git-gui[1].
+
+gui.pruneduringfetch::
+	"true" if linkgit:git-gui[1] should prune tracking branches when
+	performing a fetch. The default value is "false".
+
+gui.trustmtime::
+	Determine if linkgit:git-gui[1] should trust the file modification
+	timestamp or not. By default the timestamps are not trusted.
+
+gui.spellingdictionary::
+	Specify the dictionary used for spell checking commit messages in
+	the linkgit:git-gui[1]. When set to "none" spelling is turned off,
+	making linkgit:git-gui[1] to start on systems with aspell previous
+	to version 0.6.
+
 help.browser::
 	Specify the browser that will be used to display help in the
 	'web' format. See linkgit:git-help[1].
-- 
1.5.5.1.273.g1810b

Re: [PATCH] Documentation/config.txt: Add git-gui options

[Shawn O. Pearce]

Gustaf Hendeby <hendeby@isy.liu.se> wrote:
> The 'git gui' has a number of options that can be specified using the
> options dialog. Sometimes it is convenient to be able to specify these
> from the command line, therefor document these options.
> 
> Signed-off-by: Gustaf Hendeby <hendeby@isy.liu.se>

Acked-by: Shawn O. Pearce <speace@spearce.org>

>  Documentation/config.txt |   31 +++++++++++++++++++++++++++++++
>  1 files changed, 31 insertions(+), 0 deletions(-)
...
> +gui.spellingdictionary::
> +	Specify the dictionary used for spell checking commit messages in
> +	the linkgit:git-gui[1]. When set to "none" spelling is turned off,
> +	making linkgit:git-gui[1] to start on systems with aspell previous
> +	to version 0.6.
> +

For what it is worth, this is already fixed in git-gui.git master,
which we should be shipping with 1.5.6 when it comes out.  I just
keep getting distracted by other tasks and forget to ask Junio to
pull my tree.

-- 
Shawn.

[PATCH v2] Documentation/config.txt: Add git-gui options

[Gustaf Hendeby]

The 'git gui' has a number of options that can be specified using the
options dialog. Sometimes it is convenient to be able to specify these
from the command line, therefor document these options.

Signed-off-by: Gustaf Hendeby <hendeby@isy.liu.se>
Acked-by: Shawn O. Pearce <speace@spearce.org>
---

This patch differs from the previous one in two ways:

1. Since Shawn has fixed the problem with the spell checking already
(thanks!) and it will make its way into git soon, I removed the
comment about how gui.spellingdictionary="no can used to have git gui
start with older versions of aspell.  I think it just confuse people
if it doesn't apply any more.

2. Some of the language looked a bit strange when I read it through
this time, so I changed some wordings.  A pair of native English eyes
would probably not be a bad idea.

/Gustaf

 Documentation/config.txt |   30 ++++++++++++++++++++++++++++++
 1 files changed, 30 insertions(+), 0 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 00f089f..c4d6ccd 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -684,6 +684,36 @@ specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
 is one of "ext" and "pserver") to make them apply only for the given
 access method.
 
+gui.commitmsgwidth::
+	Defines how wide the commit message window is in the
+	linkgit:git-gui[1]. "75" is the default.
+
+gui.diffcontext::
+	Specifies how many context lines should be used in calls to diff
+	made by the linkgit:git-gui[1]. The default is "5".
+
+gui.matchtrackingbranch::
+	Determines if new branches created with linkgit:git-gui[1] should
+	default to tracking remote branches with matching names or
+	not. Default: "false".
+
+gui.newbranchtemplate::
+	Is used as suggested name when creating new branches using the
+	linkgit:git-gui[1].
+
+gui.pruneduringfetch::
+	"true" if linkgit:git-gui[1] should prune tracking branches when
+	performing a fetch. The default value is "false".
+
+gui.trustmtime::
+	Determines if linkgit:git-gui[1] should trust the file modification
+	timestamp or not. By default the timestamps are not trusted.
+
+gui.spellingdictionary::
+	Specifies the dictionary used for spell checking commit messages in
+	the linkgit:git-gui[1]. When set to "none" spell checking is turned
+	off.
+
 help.browser::
 	Specify the browser that will be used to display help in the
 	'web' format. See linkgit:git-help[1].
-- 
1.5.5.1.273.g4b2d7