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/git-clean.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/git-clean.txt') diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index e3252d59da..5e9da036ba 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -39,7 +39,7 @@ OPTIONS -x:: Don't use the ignore rules. This allows removing all untracked files, including build products. This can be used (possibly in - conjunction with gitlink:git-reset[1]) to create a pristine + conjunction with linkgit:git-reset[1]) to create a pristine working directory to test a clean build. -X:: @@ -54,4 +54,4 @@ Written by Pavel Roskin GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite -- 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/git-clean.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-clean.txt') diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 5e9da036ba..deebf3b315 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -54,4 +54,4 @@ Written by Pavel Roskin GIT --- -Part of the linkgit:git[7] suite +Part of the linkgit:git[1] suite -- cgit v1.2.3 From 459cf2e9857df069269aa733a7ce9df6f00f88ef Mon Sep 17 00:00:00 2001 From: Stephan Beyer Date: Sun, 8 Jun 2008 03:36:10 +0200 Subject: Docs: add some long/short options Namely: git-clean.txt: --dry-run --quiet git-count-objects.txt: --verbose git-quiltimport.txt: -n git-remote.txt: -v --verbose Signed-off-by: Stephan Beyer Signed-off-by: Junio C Hamano --- Documentation/git-clean.txt | 2 ++ 1 file changed, 2 insertions(+) (limited to 'Documentation/git-clean.txt') diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index deebf3b315..37a82ee4b8 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -30,9 +30,11 @@ OPTIONS git-clean will refuse to run unless given -f or -n. -n:: +--dry-run:: Don't actually remove anything, just show what would be done. -q:: +--quiet:: Be quiet, only report errors, but not the files that are successfully removed. -- cgit v1.2.3 From b1889c36d85514e5e70462294c561a02c2edfe2b Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Mon, 30 Jun 2008 01:09:04 -0500 Subject: Documentation: be consistent about "git-" versus "git " Since the git-* commands are not installed in $(bindir), using "git-command " in examples in the documentation is not a good idea. On the other hand, it is nice to be able to refer to each command using one hyphenated word. (There is no escaping it, anyway: man page names cannot have spaces in them.) This patch retains the dash in naming an operation, command, program, process, or action. Complete command lines that can be entered at a shell (i.e., without options omitted) are made to use the dashless form. The changes consist only of replacing some spaces with hyphens and vice versa. After a "s/ /-/g", the unpatched and patched versions are identical. Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-clean.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-clean.txt') diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 37a82ee4b8..f001f8f8da 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree SYNOPSIS -------- [verse] -'git-clean' [-d] [-f] [-n] [-q] [-x | -X] [--] ... +'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] ... DESCRIPTION ----------- -- 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/git-clean.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/git-clean.txt') diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index f001f8f8da..8168bf3bf4 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -27,7 +27,7 @@ OPTIONS -f:: If the git configuration specifies clean.requireForce as true, - git-clean will refuse to run unless given -f or -n. + `git-clean` will refuse to run unless given -f or -n. -n:: --dry-run:: @@ -41,7 +41,7 @@ OPTIONS -x:: Don't use the ignore rules. This allows removing all untracked files, including build products. This can be used (possibly in - conjunction with linkgit:git-reset[1]) to create a pristine + conjunction with `git-reset`) to create a pristine working directory to test a clean build. -X:: -- 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/git-clean.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/git-clean.txt') diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 8168bf3bf4..7dcc1ba58c 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -27,7 +27,7 @@ OPTIONS -f:: If the git configuration specifies clean.requireForce as true, - `git-clean` will refuse to run unless given -f or -n. + 'git-clean' will refuse to run unless given -f or -n. -n:: --dry-run:: @@ -41,7 +41,7 @@ OPTIONS -x:: Don't use the ignore rules. This allows removing all untracked files, including build products. This can be used (possibly in - conjunction with `git-reset`) to create a pristine + conjunction with 'git-reset') to create a pristine working directory to test a clean build. -X:: -- 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/git-clean.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Documentation/git-clean.txt') diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 7dcc1ba58c..8a114509f4 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree SYNOPSIS -------- [verse] -'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] ... +'git clean' [-d] [-f] [-n] [-q] [-x | -X] [--] ... DESCRIPTION ----------- @@ -16,8 +16,8 @@ Removes files unknown to git. This allows to clean the working tree from files that are not under version control. If the '-x' option is specified, ignored files are also removed, allowing to remove all build products. -When optional `...` arguments are given, the paths -affected are further limited to those that match them. +If any optional `...` arguments are given, only those paths +are affected. OPTIONS -- cgit v1.2.3 From 926337fe89f99c690b721f00239e298f8b7cad28 Mon Sep 17 00:00:00 2001 From: "Wesley J. Landaker" Date: Sat, 25 Apr 2009 09:13:40 -0600 Subject: Documentation: git-clean: fix minor grammatical errors There were a few minor grammatical errors that made this paragraph hard to read. This patch fixes the errors in a very minimal manner. Signed-off-by: Wesley J. Landaker Signed-off-by: Junio C Hamano --- Documentation/git-clean.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Documentation/git-clean.txt') diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 8a114509f4..932d44daff 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -12,9 +12,9 @@ SYNOPSIS DESCRIPTION ----------- -Removes files unknown to git. This allows to clean the working tree -from files that are not under version control. If the '-x' option is -specified, ignored files are also removed, allowing to remove all +Removes files unknown to git. This allows cleaning the working tree +of files that are not under version control. If the '-x' option is +specified, ignored files are also removed, allowing the removal of all build products. If any optional `...` arguments are given, only those paths are affected. -- cgit v1.2.3 From 911198f6c09e2a60451cf1a295ce4532ff11781c Mon Sep 17 00:00:00 2001 From: "Wesley J. Landaker" Date: Sat, 25 Apr 2009 09:13:41 -0600 Subject: Documentation: git-clean: make description more readable The existing text is a little bit awkward. This rewrites the description section to be more readable and friendly. Signed-off-by: Wesley J. Landaker Signed-off-by: Junio C Hamano --- Documentation/git-clean.txt | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'Documentation/git-clean.txt') diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 932d44daff..43b2de7db3 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -12,14 +12,17 @@ SYNOPSIS DESCRIPTION ----------- -Removes files unknown to git. This allows cleaning the working tree -of files that are not under version control. If the '-x' option is -specified, ignored files are also removed, allowing the removal of all -build products. + +This allows cleaning the working tree by removing files that are not +under version control. + +Normally, only files unknown to git are removed, but if the '-x' +option is specified, ignored files are also removed. This can, for +example, be useful to remove all build products. + If any optional `...` arguments are given, only those paths are affected. - OPTIONS ------- -d:: -- cgit v1.2.3 From 6a260f53ad685a51ecf6cd875f44cb2c056d1d18 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 6 May 2009 10:48:26 -0700 Subject: git-clean doc: the command only affects paths under $(cwd) Fredrik Skolmli and Thomas Rast noticed that it was left unstated that "git clean" ran from a subdirectory will not affect anything outside it, with or without path limiters. Signed-off-by: Junio C Hamano --- Documentation/git-clean.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/git-clean.txt') diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 43b2de7db3..be894af39f 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -13,8 +13,8 @@ SYNOPSIS DESCRIPTION ----------- -This allows cleaning the working tree by removing files that are not -under version control. +Cleans the working tree by recursively removing files that are not +under version control, starting from the current directory. Normally, only files unknown to git are removed, but if the '-x' option is specified, ignored files are also removed. This can, for -- cgit v1.2.3