commit: 12a96d466da342af96777fd94f0b12dd4b6484c0
parent ede4982f67f54904a1be6de77c6db033d56b0a34
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Wed, 6 Jan 2016 20:04:34 +0100
update man pages: document stripping of .git suffix
Diffstat:
2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/stagit-index.1 b/stagit-index.1
@@ -12,7 +12,8 @@
will create an index HTML page for the repositories specified and writes
the HTML data to stdout.
.Pp
-The basename of the directory is used as the name.
+The basename of the directory is used as the name. The suffix ".git" is
+removed from the basename, this is commonly used for "bare" repos.
.Pp
The content of the follow files specifies the meta data for each repository:
.Bl -tag -width Ds
diff --git a/stagit.1 b/stagit.1
@@ -34,11 +34,12 @@ commit/commitid.html . This file will contain the diff and diffstat of the
commit. It will write the string "binary files differ" if the data is
considered to be non-textual.
.Pp
-The basename of the directory is used as the name.
+The basename of the directory is used as the name. The suffix ".git" is
+removed from the basename, this is commonly used for "bare" repos.
.Pp
The content of the follow files specifies the meta data for each repository:
.Bl -tag -width Ds
-.It .git/description or description (bare repos).
+.It .git/description or description (bare repo).
description
.It .git/owner or owner (bare repo).
owner of repository