From 1d5bf7fcee6122931bd04c97269d64f8f282ec55 Mon Sep 17 00:00:00 2001 From: Ralf Wildenhues Date: Fri, 19 Oct 2007 19:24:43 +0200 Subject: gitk.txt: Fix markup. For the manpage, avoid generating an em dash in code. Signed-off-by: Ralf Wildenhues Signed-off-by: Shawn O. Pearce --- Documentation/gitk.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index e9f82b97b9..8dbfb0d5a3 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -69,7 +69,7 @@ gitk --since="2 weeks ago" \-- gitk:: The "--" is necessary to avoid confusion with the *branch* named 'gitk' -gitk --max-count=100 --all -- Makefile:: +gitk --max-count=100 --all \-- Makefile:: Show at most 100 changes made to the file 'Makefile'. Instead of only looking for changes in the current branch look in all branches. -- cgit v1.2.3 From 5162e69732d13dd079919a389a6ace8878aad716 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Sat, 29 Dec 2007 00:20:38 -0600 Subject: Documentation: rename gitlink macro to linkgit Between AsciiDoc 8.2.2 and 8.2.3, the following change was made to the stock Asciidoc configuration: @@ -149,7 +153,10 @@ # Inline macros. # Backslash prefix required for escape processing. # (?s) re flag for line spanning. -(?su)[\\]?(?P\w(\w|-)*?):(?P\S*?)(\[(?P.*?)\])= + +# Explicit so they can be nested. +(?su)[\\]?(?P(http|https|ftp|file|mailto|callto|image|link)):(?P\S*?)(\[(?P.*?)\])= + # Anchor: [[[id]]]. Bibliographic anchor. (?su)[\\]?\[\[\[(?P[\w][\w-]*?)\]\]\]=anchor3 # Anchor: [[id,xreflabel]] This default regex now matches explicit values, and unfortunately in this case gitlink was being matched by just 'link', causing the wrong inline macro template to be applied. By renaming the macro, we can avoid being matched by the wrong regex. Signed-off-by: Dan McGee Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index 8dbfb0d5a3..29edafceda 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -22,7 +22,7 @@ git repository. OPTIONS ------- To control which revisions to shown, the command takes options applicable to -the gitlink:git-rev-list[1] command. This manual page describes only the most +the linkgit:git-rev-list[1] command. This manual page describes only the most frequently used options. -n , --max-count=:: @@ -48,7 +48,7 @@ frequently used options. the form "''..''" to show all revisions between '' and back to ''. Note, more advanced revision selection can be applied. For a more complete list of ways to spell object names, see - "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1]. + "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. :: @@ -98,4 +98,4 @@ Documentation by Junio C Hamano, Jonas Fonseca, and the git-list GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite -- cgit v1.2.3 From e80950786c16e642be76976a8926b2846ba0aa4f Mon Sep 17 00:00:00 2001 From: Clifford Caoile Date: Sat, 12 Apr 2008 18:50:20 +0900 Subject: Docs gitk: Explicitly mention the files that gitk uses (~/.gitk) gitk creates and uses ~/.gitk Signed-off-by: Clifford Caoile Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index 29edafceda..ed3ba83c53 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -74,6 +74,11 @@ gitk --max-count=100 --all \-- Makefile:: Show at most 100 changes made to the file 'Makefile'. Instead of only looking for changes in the current branch look in all branches. +Files +----- +Gitk creates the .gitk file in your $HOME directory to store preferences +such as display options, font, and colors. + See Also -------- 'qgit(1)':: -- cgit v1.2.3 From 9f1915d3935ea6e5e0a5cc38355a2dc30c4a811f Mon Sep 17 00:00:00 2001 From: Richard Quirk Date: Mon, 28 Apr 2008 22:58:35 +0200 Subject: Documentation gitk: Describe what --merge does Signed-off-by: Richard Quirk Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index ed3ba83c53..50d12da89f 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -41,6 +41,12 @@ frequently used options. Show all branches. +--merge:: + + After an attempt to merge stops with conflicts, show the commits on + the history between two branches (i.e. the HEAD and the MERGE_HEAD) + that modify the conflicted files. + :: Limit the revisions to show. This can be either a single revision -- cgit v1.2.3 From 56ae8df5c7b05ee8982c9447fa31116104dc568f Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 28 May 2008 16:55:27 -0700 Subject: Manual subsection to refer to other pages is SEE ALSO Consistently say so in all caps as it is customary to do so. Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index 50d12da89f..b88fd9566a 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -85,7 +85,7 @@ Files Gitk creates the .gitk file in your $HOME directory to store preferences such as display options, font, and colors. -See Also +SEE ALSO -------- 'qgit(1)':: A repository browser written in C++ using Qt. -- cgit v1.2.3 From 9e1f0a85c68323830ea117092c55192b17aa3ac8 Mon Sep 17 00:00:00 2001 From: Christian Couder Date: Fri, 6 Jun 2008 09:07:32 +0200 Subject: documentation: move git(7) to git(1) As the "git" man page describes the "git" command at the end-user level, it seems better to move it to man section 1. Signed-off-by: Christian Couder Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index b88fd9566a..14bcf91f40 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -109,4 +109,4 @@ Documentation by Junio C Hamano, Jonas Fonseca, and the git-list GIT --- -Part of the linkgit:git[7] suite +Part of the linkgit:git[1] suite -- cgit v1.2.3 From 3240240ff427fa2e26a847c7c9fd89e6a4313daa Mon Sep 17 00:00:00 2001 From: Stephan Beyer Date: Sun, 8 Jun 2008 03:36:09 +0200 Subject: Docs: Use "-l::\n--long\n" format in OPTIONS sections The OPTIONS section of a documentation file contains a list of the options a git command accepts. Currently there are several variants to describe the case that different options (almost) do the same in the OPTIONS section. Some are: -f, --foo:: -f|--foo:: -f | --foo:: But AsciiDoc has the special form: -f:: --foo:: This patch applies this form to the documentation of the whole git suite, and removes useless em-dash prevention, so \--foo becomes --foo. Signed-off-by: Stephan Beyer Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index 14bcf91f40..f843f39bf2 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -25,7 +25,8 @@ To control which revisions to shown, the command takes options applicable to the linkgit:git-rev-list[1] command. This manual page describes only the most frequently used options. --n , --max-count=:: +-n :: +--max-count=:: Limits the number of commits to show. -- cgit v1.2.3 From 483bc4f045881b998512ae814d6cf44d0c0cb493 Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Mon, 30 Jun 2008 13:56:34 -0500 Subject: Documentation formatting and cleanup Following what appears to be the predominant style, format names of commands and commandlines both as `teletype text`. While we're at it, add articles ("a" and "the") in some places, italicize the name of the command in the manual page synopsis line, and add a comma or two where it seems appropriate. Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index f843f39bf2..03688bfa6b 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -22,7 +22,8 @@ git repository. OPTIONS ------- To control which revisions to shown, the command takes options applicable to -the linkgit:git-rev-list[1] command. This manual page describes only the most +the `git-rev-list` command (see linkgit:git-rev-list[1]). +This manual page describes only the most frequently used options. -n :: -- cgit v1.2.3 From ba020ef5eb5fca3d757bd580ff117adaf81ca079 Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Thu, 3 Jul 2008 00:41:41 -0500 Subject: manpages: italicize git command names (which were in teletype font) The names of git commands are not meant to be entered at the commandline; they are just names. So we render them in italics, as is usual for command names in manpages. Using doit () { perl -e 'for (<>) { s/\`(git-[^\`.]*)\`/'\''\1'\''/g; print }' } for i in git*.txt config.txt diff*.txt blame*.txt fetch*.txt i18n.txt \ merge*.txt pretty*.txt pull*.txt rev*.txt urls*.txt do doit <"$i" >"$i+" && mv "$i+" "$i" done git diff . Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index 03688bfa6b..e02ecf5744 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -22,7 +22,7 @@ git repository. OPTIONS ------- To control which revisions to shown, the command takes options applicable to -the `git-rev-list` command (see linkgit:git-rev-list[1]). +the 'git-rev-list' command (see linkgit:git-rev-list[1]). This manual page describes only the most frequently used options. -- cgit v1.2.3 From f448e24e2fe336621306b04b84e947bdd04f7ecc Mon Sep 17 00:00:00 2001 From: Abhijit Menon-Sen Date: Wed, 30 Jul 2008 15:03:43 +0530 Subject: Make the DESCRIPTION match ... items in the SYNOPSIS When the SYNOPSIS says e.g. "...", it is nice if the DESCRIPTION also mentions "..." and says the specified "paths" (note plural) are used for $whatever. This fixes the obvious mismatches. Signed-off-by: Abhijit Menon-Sen Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index e02ecf5744..6e827cd11c 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -58,7 +58,7 @@ frequently used options. For a more complete list of ways to spell object names, see "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. -:: +...:: Limit commits to the ones touching files in the given paths. Note, to avoid ambiguity wrt. revision names use "--" to separate the paths -- cgit v1.2.3 From 29f28151c5ac0ed842e9a00438f1930ee4052757 Mon Sep 17 00:00:00 2001 From: Yann Dirson Date: Fri, 29 Aug 2008 00:00:28 +0200 Subject: Document gitk --argscmd flag. This was part of my original patch, but appears to have been lost. Signed-off-by: Yann Dirson Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index 6e827cd11c..ae29a00d59 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -49,6 +49,13 @@ frequently used options. the history between two branches (i.e. the HEAD and the MERGE_HEAD) that modify the conflicted files. +--argscmd=:: + Command to be run each time gitk has to determine the list of + to show. The command is expected to print on its standard + output a list of additional revs to be shown, one per line. + Use this instead of explicitly specifying if the set of + commits to show may vary between refreshes. + :: Limit the revisions to show. This can be either a single revision -- cgit v1.2.3 From a2df1fb2e52a49bf6b17b352581510efd851f337 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Thu, 13 Nov 2008 20:28:49 +0300 Subject: 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 Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index ae29a00d59..317f6317c2 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -56,6 +56,11 @@ frequently used options. Use this instead of explicitly specifying if the set of commits to show may vary between refreshes. +--select-commit=:: + + Automatically select the specified commit after loading the graph. + Default behavior is equivalent to specifying '--select-commit=HEAD'. + :: Limit the revisions to show. This can be either a single revision -- cgit v1.2.3 From 04c8ce9c1c803a8dc0f3728f57550f9bc9e605c2 Mon Sep 17 00:00:00 2001 From: Markus Heidelberg Date: Fri, 19 Dec 2008 13:14:18 +0100 Subject: Documentation: fix typos, grammar, asciidoc syntax Signed-off-by: Markus Heidelberg Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index ae29a00d59..5ef3687e39 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -21,7 +21,7 @@ git repository. OPTIONS ------- -To control which revisions to shown, the command takes options applicable to +To control which revisions to show, the command takes options applicable to the 'git-rev-list' command (see linkgit:git-rev-list[1]). This manual page describes only the most frequently used options. @@ -75,7 +75,7 @@ Examples -------- gitk v2.6.12.. include/scsi drivers/scsi:: - Show as the changes since version 'v2.6.12' that changed any + Show the changes since version 'v2.6.12' that changed any file in the include/scsi or drivers/scsi subdirectories gitk --since="2 weeks ago" \-- gitk:: -- cgit v1.2.3 From 3021faf6562690658d0b9f9fdd7cbe8c9dd61628 Mon Sep 17 00:00:00 2001 From: Sitaram Chamarty Date: Fri, 6 Feb 2009 10:10:53 +0530 Subject: Documentation: clarify commits affected by gitk --merge Signed-off-by: Sitaram Chamarty Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index 4673a75a98..bd005bc5c8 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -47,7 +47,8 @@ frequently used options. After an attempt to merge stops with conflicts, show the commits on the history between two branches (i.e. the HEAD and the MERGE_HEAD) - that modify the conflicted files. + that modify the conflicted files and do not exist on all the heads + being merged. --argscmd=:: Command to be run each time gitk has to determine the list of -- cgit v1.2.3 From 5a4aaaf3aa2ef02b6b397206cf222643b68b36c7 Mon Sep 17 00:00:00 2001 From: Mike Ralphson Date: Tue, 3 Mar 2009 19:29:21 +0000 Subject: Documentation: Expand a couple of abbreviations These may not be obvious to non-native English speakers Signed-off-by: Mike Ralphson Signed-off-by: Junio C Hamano --- Documentation/gitk.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/gitk.txt') diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index bd005bc5c8..cf465cb47e 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -74,7 +74,7 @@ frequently used options. ...:: Limit commits to the ones touching files in the given paths. Note, to - avoid ambiguity wrt. revision names use "--" to separate the paths + avoid ambiguity with respect to revision names use "--" to separate the paths from any preceding options. Examples -- cgit v1.2.3