Commits

Greg Ward  committed 954e7db

Tweak docs

  • Participants
  • Parent commits 7df4f2e

Comments (0)

Files changed (3)

 
 vcprompt has minimal dependencies: it does as much as it can with the
 standard C library and POSIX calls. It should work on any
-POSIX-compliant system with a C99 compiler. Some features will only
-work with the help of an external library (see "Dependencies" below).
+POSIX-compliant system with a C99 compiler. Some optional features
+require external libraries (see "Dependencies" below).
 
 To build vcprompt from the source tarball:
 
 
 vcprompt always requires GNU make to build.
 
-vcprompt requires GNU autoconf to build from a source checkout (but
-not if you are building from a source tarball).
+vcprompt requires GNU autoconf to build from a source checkout (not
+from a source tarball).
 
 Support for Subversion >= 1.7 requires SQLite 3. If it's not present on
 the build system, vcprompt will support Subversion <= 1.6. Either way,
 
   make check
 
-If it fails, it should be loud and obvious. Please report any test
+Test failures should be loud and obvious. Please report any test
 failures to the development mailing list:
-vcprompt-devel@googlegroups.com.
+
+  vcprompt-devel@googlegroups.com.
 
 To check for memory errors, you can run vcprompt's test suite under
 valgrind:
 
 * read through README.txt and make sure it's still valid
 
-* read the man page and make sure it's still valid
-  (groff -Tascii -man vcprompt.1 | less)
+* read the man page and make sure it's still valid:
+
+    groff -Tascii -man vcprompt.1 | less
 
 * commit any required changes
 
 .SH DESCRIPTION
 
 Examine the current working directory, determine what version control
-system manages it, and print a short summary to stdout. You then
+system manages it, and print a short summary to stdout. You must
 configure your shell to run
 .B vcprompt
 for every prompt, and your prompt will include that short summary.
 branch, e.g.
 .nf
 .in +4m
-[cvs:trunk]
 [git:master]
 [hg:default]
+[svn:trunk]
+[cvs:trunk]
 [fossil:trunk]
 .in -4m
 .fi
 
 If the current directory is not under version control,
 .B vcprompt
-terminates quickly with no output.
+prints nothing and exits.
 
 .SH OPTIONS
 .IP -d
 .I .svn
 exists.
 .B vcprompt
-currently supports Subversion up to version 1.7 (version 1.8
-untested).
+currently supports Subversion up to version 1.8.
 
 .B %b
 is supported by parsing the repository URL corresponding to the