threads / patch / 19120

patchDocumentation: Fix description of archive "--prefix"

Subject: [PATCH] Documentation: Fix description of archive "--prefix"

## tl;dr

3 messages between Apr 29, 2009 and Apr 30, 2009. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Holger Weiß· Apr 29, 2009, 13:42 UTC · lore

The description of the "--prefix" option suggested that a slash would automatically be appended to the specified <prefix>, which is not the case.

Signed-off-by: Holger Weiß <holger@zedat.fu-berlin.de>
---
 Documentation/git-archive.txt |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

Show changes to Documentation/git-archive.txt +3 −2

diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt
index ad38f7f..6848e62 100644
--- a/Documentation/git-archive.txt
+++ b/Documentation/git-archive.txt
@@ -9,7 +9,7 @@ git-archive - Create an archive of files from a named tree
 SYNOPSIS
 --------
 [verse]
-'git archive' --format=<fmt> [--list] [--prefix=<prefix>/] [<extra>]
+'git archive' --format=<fmt> [--list] [--prefix=<prefix>] [<extra>]
 	      [--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
 	      [path...]
 
@@ -44,8 +44,8 @@ OPTIONS
 --verbose::
 	Report progress to stderr.
 
---prefix=<prefix>/::
-	Prepend <prefix>/ to each filename in the archive.
+--prefix=<prefix>::
+	Prepend <prefix> to each filename in the archive.
 
 <extra>::
 	This can be any options that the archiver backend understands.

-- 
1.6.2.4

Holger Weiß· Apr 29, 2009, 15:49 UTC · re: Holger Weiß · lore

Re: [PATCH] Documentation: Fix description of archive "--prefix"

* Holger Weiß <holger@zedat.fu-berlin.de> [2009-04-29 15:42]:

> The description of the "--prefix" option suggested that a slash would
> automatically be appended to the specified <prefix>, which is not the
> case.

Nonsense, it's telling the user that appending a slash to the <prefix> is mandatory. Scratch my patch.

Sorry, Holger

Wesley J. Landaker· Apr 30, 2009, 02:33 UTC · re: Holger Weiß · lore

Re: [PATCH] Documentation: Fix description of archive "--prefix"

On Wednesday 29 April 2009 09:49:41 Holger Weiß wrote:

Show 7 quoted lines

> * Holger Weiß <holger@zedat.fu-berlin.de> [2009-04-29 15:42]:
> > The description of the "--prefix" option suggested that a slash would
> > automatically be appended to the specified <prefix>, which is not the
> > case.
>
> Nonsense, it's telling the user that appending a slash to the <prefix>
> is mandatory.  Scratch my patch.

I just tried not using a slash; it doesn't give an error or internally add one, instead it makes a worthless archive:

$ git archive --prefix=noslash HEAD | tar tv | head -rw-rw-r-- root/root 51 2009-04-28 01:46 noslash.gitattributes -rw-rw-r-- root/root 2416 2009-04-28 01:46 noslash.gitignore -rw-rw-r-- root/root 2519 2009-04-28 01:46 noslash.mailmap -rw-rw-r-- root/root 18787 2009-04-28 01:46 noslashCOPYING drwxrwxr-x root/root 0 2009-04-28 01:46 noslashDocumentation/ -rw-rw-r-- root/root 17 2009-04-28 01:46 noslashDocumentation/.gitattributes -rw-rw-r-- root/root 91 2009-04-28 01:46 noslashDocumentation/.gitignore -rw-rw-r-- root/root 4868 2009-04-28 01:46 noslashDocumentation/CodingGuidelines -rw-rw-r-- root/root 9028 2009-04-28 01:46 noslashDocumentation/Makefile -rw-rw-r-- root/root 1255 2009-04-28 01:46 noslashDocumentation/RelNotes-1.5.0.1.txt

Should this be fixed by automatically adding a slash if there wasn't one given? I can't image anyone would want an archive made of mangled filenames like this, so if we don't want that behavior, it seems like it should at least give an error.