Commits

Greg Ward committed 3bce807

man page: tighten up the wording in various spots

  • Participants
  • Parent commits f1b7ef2

Comments (0)

Files changed (1)

 You can get different information by specifying a format string with
 the -f option. See \fBFORMAT STRINGS\fR below.
 
-In a directory that is not under the control of a supported version
-control system,
+If the current directory is not under version control,
 .B vcprompt
-terminates quickly and with no output.
+terminates quickly with no output.
 
 .SH OPTIONS
 .IP -d
 .I .git
 exists.
 
-Format specifier
 .B %b
-(branch) is supported by reading file
+(branch) is supported by reading
 .I .git/HEAD
 directly. If that file does not refer to a branch (e.g. you have
 checked out a specified commit), then
 .B vcprompt
 reports the branch as "unknown".
 
-Format specifier
 .B %r
 (revision) expands to the first 12 characters of the commit ID of
 HEAD.
 
-Format specifier
 .B %p
 is not yet implemented.
 
-Format specifier
 .B %u
 is supported by running "git ls-files --others --exclude-standard", so
-it can be expensive in a large working dir.
+it can be slow in a large working dir.
 
-Format specifier
 .B %m
 is supported by running "git diff --no-ext-diff --quiet --exit-code",
-so it can be expensive in a large working dir.
+so it can be slow in a large working dir.
 
 .SH MERCURIAL (HG) SUPPORT
 
 .I .hg
 exists.
 
-Format specifier
 .B %b
 (branch) is supported by looking for the current Mercurial bookmark (
 .I .hg/bookmarks.current
 .I .hg/branch
 ) if no bookmark is current.
 
-Format specifier
 .B %r
 (revision) expands to the revision number of the parent of the working
 dir, or a comma-separated pair of revision numbers if a merge is
 .B vcprompt
 !
 
-Format specifier
 .B %p
 is implemented by reading MQ internals.
 
-Format specifiers
 .B %u
 and
 .B %m
-are implemented by running "hg status", so they can be expensive in a
+are implemented by running "hg status", so they can be slow in a
 large working dir. Mercurial has to work harder to find unknown files
 than it does to find uncommitted changes, so using
 .B %u
 .SH SUBVERSION (SVN) SUPPORT
 
 .B vcprompt
-currently supports Subversion up to version 1.6. It doesn't yet
-recognize Subversion 1.7 working copies. Patches are welcome!
-
-.B vcprompt
 considers the current directory a Subversion (svn) working dir if
 directory
 .I .svn
 exists.
+.B vcprompt
+currently supports Subversion up to version 1.6. It doesn't yet
+recognize Subversion 1.7 working copies. Patches are welcome!
 
-Format specifier
 .B %b
 is not supported because Subversion has no guaranteed way to figure
 out the branch; projects can structure their repository however they
 directories and which is the branch name. There might not even be a
 branch name.
 
-Format specifier
 .B %p
 is not implemented (it makes no sense with Subversion).
 
-Format specifiers
 .B %u
 and
 .B %m
 .I CVS/Entries
 exists.
 
-Format specifier
 .B %b
 (branch) is supported by reading
 .I CVS/Tag;
 looks only in the current dir, not in any subdirectories, so it will
 not detect mixed-branch working dirs.
 
-Format specifier
 .B %r
 is not supported because CVS has no global revision ID.
 
-Format specifier
 .B %p
 is not implemented (it makes no sense with CVS).
 
-Format specifiers
 .B %u
 and
 .B %m
 All format specifiers depend on running "fossil" commands, so every
 operation in a Fossil working dir is slow. All format specifiers except
 .B %u
-depend on "fossil status", so there's no harm in using lots of format
-specifiers -- however, doing so
+depend on a single run of "fossil status", so there's no harm in using
+lots of format specifiers (however, doing so
 .I is
-expensive for other version control systems.
+expensive for other version control systems).
 
 Format specifier
 .B %p
 Format specifier
 .B %u
 requires running "fossil extra", so has an extra penalty compared to
-the ther format specifiers.
+the other format specifiers.
 
 .SH CONFIGURING BASH
 
 to your
 .I ~/.zshrc
 file. You can of course use all of zsh's prompt escapes in
-.B PROMPT;
-this example just uses "$ " for the rest of the prompt.
+.B PROMPT.
 
 .SH ENVIRONMENT
 .IP VCPROMPT_FORMAT