From: Eric S. Raymond Date: Sat, 8 Nov 2014 16:21:45 +0000 (-0500) Subject: Documentation polishing. X-Git-Tag: 0.2~17 X-Git-Url: http://thyrsus.com/gitweb/?a=commitdiff_plain;h=921f766d956fb3474d94bf5d26d2c1061daa44f8;p=src.git Documentation polishing. --- diff --git a/src.asc b/src.asc index 969be72..9116b2e 100644 --- a/src.asc +++ b/src.asc @@ -15,10 +15,10 @@ venerable RCS, hence the anagrammatic acronym. The desigh is tuned for use cases like all those little scripts in your ~/bin directory, or a directory full of HOWTOs. -SRC revision histories are single, human-readable files beneath a hidden .src -subdirectory in the directory where they live. There may be multiple -histories under one directory; SRC treats them as separate projects, -and history files can be moved elsewhere at any time. +SRC revision histories are single, human-readable files beneath a +hidden .src subdirectory in the directory where they live. There may +be multiple histories under one directory; SRC treats them as separate +projects, and history files can be moved elsewhere at any time. SRC gives you simple, consecutive integer revision numbers. It supports tags and branching. It does not show committer information, @@ -110,7 +110,8 @@ succeeded. This behavior can be suppressed with the -q option, placed == BACKWARD COMPATIBILITY == -SRC history files are RCS master files. There is no hidden state. +SRC history files are RCS master files. SRC maintains no state other +than these files. In order to maintain complete backwards compatibility, one compromise was made: any commit comment containing a string exactly matching an @@ -136,13 +137,16 @@ revision and fixes the user information to be used in fast-export; It also attributes all commits to J. Random Hacker and sets a constant screen witch of 79. It's for regression testing. -== DANGER! DANGER! == -This is a proof-of-concept alpha release. The 'branch' command is not -yet implemented; it is described here to document the design. +== LIMITATIONS == + +The 'branch' command is not yet implemented; it is described here to +document the UI design choice. == REPORTING BUGS == + Report bugs to Eric S. Raymond . The project page is at http://catb.org/~esr/src == SEE ALSO == + rcs(1).