threads / patch / 47273

patchprune: add "--progress" to man page and usage msg

Subject: [PATCH] prune: add "--progress" to man page and usage msg

## tl;dr

2 messages between Nov 21, 2017 and Nov 22, 2017. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

Robert P. J. Day· Nov 21, 2017, 15:51 UTC · lore

Add mention of git prune's "--progress" option to the SYNOPSIS and DESCRIPTION sections of the man page, and to the usage message of "git prune" itself.

While we're here, move the explanation of "--" toward the end of the DESCRIPTION section, where it belongs.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

Show changes to 2 files +7 −4

Documentation/git-prune.txt, builtin/prune.c

diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt
index 7a493c80f..a37c0af93 100644
--- a/Documentation/git-prune.txt
+++ b/Documentation/git-prune.txt
@@ -9,7 +9,7 @@ git-prune - Prune all unreachable objects from the object database
 SYNOPSIS
 --------
 [verse]
-'git prune' [-n] [-v] [--expire <expire>] [--] [<head>...]
+'git prune' [-n] [-v] [--progress] [--expire <time>] [--] [<head>...]

 DESCRIPTION
 -----------
@@ -42,12 +42,15 @@ OPTIONS
 --verbose::
 	Report all removed objects.

-\--::
-	Do not interpret any more arguments as options.
+--progress::
+	Show progress.

 --expire <time>::
 	Only expire loose objects older than <time>.

+\--::
+	Do not interpret any more arguments as options.
+
 <head>...::
 	In addition to objects
 	reachable from any of our references, keep objects
diff --git a/builtin/prune.c b/builtin/prune.c
index cddabf26a..d2fdae680 100644
--- a/builtin/prune.c
+++ b/builtin/prune.c
@@ -8,7 +8,7 @@
 #include "progress.h"

 static const char * const prune_usage[] = {
-	N_("git prune [-n] [-v] [--expire <time>] [--] [<head>...]"),
+	N_("git prune [-n] [-v] [--progress] [--expire <time>] [--] [<head>...]"),
 	NULL
 };
 static int show_only;

-- 
========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

Junio C Hamano· Nov 22, 2017, 03:29 UTC · re: Robert P. J. Day · lore

Re: [PATCH] prune: add "--progress" to man page and usage msg

"Robert P. J. Day" <rpjday@crashcourse.ca> writes:

Show 6 quoted lines

> Add mention of git prune's "--progress" option to the SYNOPSIS and
> DESCRIPTION sections of the man page, and to the usage message of "git
> prune" itself.
>
> While we're here, move the explanation of "--" toward the end of the
> DESCRIPTION section, where it belongs.

Thanks, both changes make sense.  Will queue.

Show 49 quoted lines

>
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>
> ---
>
> diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt
> index 7a493c80f..a37c0af93 100644
> --- a/Documentation/git-prune.txt
> +++ b/Documentation/git-prune.txt
> @@ -9,7 +9,7 @@ git-prune - Prune all unreachable objects from the object database
>  SYNOPSIS
>  --------
>  [verse]
> -'git prune' [-n] [-v] [--expire <expire>] [--] [<head>...]
> +'git prune' [-n] [-v] [--progress] [--expire <time>] [--] [<head>...]
>
>  DESCRIPTION
>  -----------
> @@ -42,12 +42,15 @@ OPTIONS
>  --verbose::
>  	Report all removed objects.
>
> -\--::
> -	Do not interpret any more arguments as options.
> +--progress::
> +	Show progress.
>
>  --expire <time>::
>  	Only expire loose objects older than <time>.
>
> +\--::
> +	Do not interpret any more arguments as options.
> +
>  <head>...::
>  	In addition to objects
>  	reachable from any of our references, keep objects
> diff --git a/builtin/prune.c b/builtin/prune.c
> index cddabf26a..d2fdae680 100644
> --- a/builtin/prune.c
> +++ b/builtin/prune.c
> @@ -8,7 +8,7 @@
>  #include "progress.h"
>
>  static const char * const prune_usage[] = {
> -	N_("git prune [-n] [-v] [--expire <time>] [--] [<head>...]"),
> +	N_("git prune [-n] [-v] [--progress] [--expire <time>] [--] [<head>...]"),
>  	NULL
>  };
>  static int show_only;