threads / patch / 35258

patchDocumentation: restore a space in unpack-objects usage

Subject: [PATCH] Documentation: restore a space in unpack-objects usage

## tl;dr

3 messages between Oct 31, 2013 and Nov 1, 2013. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Vivien Didelot· Oct 31, 2013, 21:41 UTC · lore

The commit 87b7b84 removed a space in the unpack-objects usage, which makes the synopsis a bit confusing. This patch simply restores it.

Signed-off-by: Vivien Didelot <vivien.didelot@savoirfairelinux.com>
---
 Documentation/git-unpack-objects.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to Documentation/git-unpack-objects.txt +1 −1

diff --git a/Documentation/git-unpack-objects.txt b/Documentation/git-unpack-objects.txt
index ff23494..817788e 100644
--- a/Documentation/git-unpack-objects.txt
+++ b/Documentation/git-unpack-objects.txt
@@ -9,7 +9,7 @@ git-unpack-objects - Unpack objects from a packed archive
 SYNOPSIS
 --------
 [verse]
-'git unpack-objects' [-n] [-q] [-r] [--strict] <pack-file
+'git unpack-objects' [-n] [-q] [-r] [--strict] < pack-file
 
 
 DESCRIPTION

-- 
1.8.4.2

Junio C Hamano· Oct 31, 2013, 22:09 UTC · re: Vivien Didelot · lore

Re: [PATCH] Documentation: restore a space in unpack-objects usage

Vivien Didelot <vivien.didelot@savoirfairelinux.com> writes:

Show 18 quoted lines

> The commit 87b7b84 removed a space in the unpack-objects usage, which
> makes the synopsis a bit confusing. This patch simply restores it.
>
> Signed-off-by: Vivien Didelot <vivien.didelot@savoirfairelinux.com>
> ---
>  Documentation/git-unpack-objects.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-unpack-objects.txt b/Documentation/git-unpack-objects.txt
> index ff23494..817788e 100644
> --- a/Documentation/git-unpack-objects.txt
> +++ b/Documentation/git-unpack-objects.txt
> @@ -9,7 +9,7 @@ git-unpack-objects - Unpack objects from a packed archive
>  SYNOPSIS
>  --------
>  [verse]
> -'git unpack-objects' [-n] [-q] [-r] [--strict] <pack-file
> +'git unpack-objects' [-n] [-q] [-r] [--strict] < pack-file

Thanks; that change was indeed not intended.

Looking at synopsis sections for other commands that take their input from the standard input (e.g. "git check-attr"), I think we should make it clear that "pack-file" is not to be spelled as-is at the same time, i.e.

	'git unpack-objects' [-n] [-q] [-r] [--strict] < <pack-file>

Vivien Didelot· Nov 1, 2013, 15:42 UTC · re: Junio C Hamano · lore

[PATCH] Documentation: "pack-file" is not literal in unpack-objects

This patch makes it clear that "pack-file" is not to be spelled as is in the unpack-objects usage.

Signed-off-by: Vivien Didelot <vivien.didelot@savoirfairelinux.com>
---
 Documentation/git-unpack-objects.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Show changes to Documentation/git-unpack-objects.txt +1 −1

diff --git a/Documentation/git-unpack-objects.txt b/Documentation/git-unpack-objects.txt
index 817788e..12cb108 100644
--- a/Documentation/git-unpack-objects.txt
+++ b/Documentation/git-unpack-objects.txt
@@ -9,7 +9,7 @@ git-unpack-objects - Unpack objects from a packed archive
 SYNOPSIS
 --------
 [verse]
-'git unpack-objects' [-n] [-q] [-r] [--strict] < pack-file
+'git unpack-objects' [-n] [-q] [-r] [--strict] < <pack-file>
 
 
 DESCRIPTION

-- 
1.8.4.2