Documentation: New GUI configuration and command-line options.
Add information on new git-gui and gitk command-line options, configuration variables, and the encoding attribute. Signed-off-by: Alexander Gavrilov <angavrilov@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Alexander Gavrilov committed
Nov 13, 2008 at 20:28 UTC
a2df1fb2e52a49bf6b17b352581510efd851f337
4 files changed
+65
Documentation/config.txt
+24
@@ -796,6 +796,14 @@ gui.diffcontext::
796
Specifies how many context lines should be used in calls to diff
797
made by the linkgit:git-gui[1]. The default is "5".
798
799
+gui.encoding::
800
+ Specifies the default encoding to use for displaying of
801
+ file contents in linkgit:git-gui[1] and linkgit:gitk[1].
802
+ It can be overridden by setting the 'encoding' attribute
803
+ for relevant files (see linkgit:gitattributes[5]).
804
+ If this option is not set, the tools default to the
805
+ locale encoding.
806
+
807
gui.matchtrackingbranch::
808
Determines if new branches created with linkgit:git-gui[1] should
809
default to tracking remote branches with matching names or
@@ -818,6 +826,22 @@ gui.spellingdictionary::
826
the linkgit:git-gui[1]. When set to "none" spell checking is turned
827
off.
828
829
+gui.fastcopyblame::
830
+ If true, 'git gui blame' uses '-C' instead of '-C -C' for original
831
+ location detection. It makes blame significantly faster on huge
832
+ repositories at the expense of less thorough copy detection.
833
+
834
+gui.copyblamethreshold::
835
+ Specifies the theshold to use in 'git gui blame' original location
836
+ detection, measured in alphanumeric characters. See the
837
+ linkgit:git-blame[1] manual for more information on copy detection.
838
+
839
+gui.blamehistoryctx::
840
+ Specifies the radius of history context in days to show in
841
+ linkgit:gitk[1] for the selected commit, when the `Show History
842
+ Context` menu item is invoked from 'git gui blame'. If this
843
+ variable is set to zero, the whole history is shown.
844
+
845
help.browser::
846
Specify the browser that will be used to display help in the
847
'web' format. See linkgit:git-help[1].
Documentation/git-gui.txt
+19
@@ -65,9 +65,28 @@ git gui blame v0.99.8 Makefile::
65
example the file is read from the object database and not
66
the working directory.
67
68
+git gui blame --line=100 Makefile::
69
+
70
+ Loads annotations as described above and automatically
71
+ scrolls the view to center on line '100'.
72
+
73
git gui citool::
74
75
Make one commit and return to the shell when it is complete.
76
+ This command returns a non-zero exit code if the window was
77
+ closed in any way other than by making a commit.
78
+
79
+git gui citool --amend::
80
+
81
+ Automatically enter the 'Amend Last Commit' mode of
82
+ the interface.
83
+
84
+git gui citool --nocommit::
85
+
86
+ Behave as normal citool, but instead of making a commit
87
+ simply terminate with a zero exit code. It still checks
88
+ that the index does not contain any unmerged entries, so
89
+ you can use it as a GUI version of linkgit:git-mergetool[1]
90
91
git citool::
92
Documentation/gitattributes.txt
+17
@@ -535,6 +535,23 @@ in the file. E.g. the string `$Format:%H$` will be replaced by the
535
commit hash.
536
537
538
+Viewing files in GUI tools
539
+~~~~~~~~~~~~~~~~~~~~~~~~~~
540
+
541
+`encoding`
542
+^^^^^^^^^^
543
+
544
+The value of this attribute specifies the character encoding that should
545
+be used by GUI tools (e.g. linkgit:gitk[1] and linkgit:git-gui[1]) to
546
+display the contents of the relevant file. Note that due to performance
547
+considerations linkgit:gitk[1] does not use this attribute unless you
548
+manually enable per-file encodings in its options.
549
+
550
+If this attribute is not set or has an invalid value, the value of the
551
+`gui.encoding` configuration variable is used instead
552
+(See linkgit:git-config[1]).
553
+
554
+
555
USING ATTRIBUTE MACROS
556
----------------------
557
Documentation/gitk.txt
+5
@@ -56,6 +56,11 @@ frequently used options.
56
Use this instead of explicitly specifying <revs> if the set of
57
commits to show may vary between refreshes.
58
59
+--select-commit=<ref>::
60
+
61
+ Automatically select the specified commit after loading the graph.
62
+ Default behavior is equivalent to specifying '--select-commit=HEAD'.
63
+
64
<revs>::
65
66
Limit the revisions to show. This can be either a single revision