From: Eric S. Raymond <esr@thyrsus.com>
Date: Wed, 20 Oct 2010 17:14:04 +0000 (-0400)
Subject: Actually document this thing.
X-Git-Tag: 1.6~1
X-Git-Url: http://thyrsus.com/gitweb/?a=commitdiff_plain;h=83f324c681207069870b168d564bc142adc98493;p=sccs2rcs.git

Actually document this thing.
---

diff --git a/sccs2rcs b/sccs2rcs
index bacb910..f96b965 100755
--- a/sccs2rcs
+++ b/sccs2rcs
@@ -1,7 +1,35 @@
 #!/usr/bin/env python
 #
+# USAGE:
+#
 # sccs2rcs is a script to convert an existing SCCS history into an RCS
 # history without losing any of the information contained therein.
+# It requires that the SCCS and RCS tools be installed on your system. 
+#
+# Run this in a directory with an SCCS subdirectory. It will convert
+# all the SCCS files to corresponding RCS master files in a new RCS
+# directory; the SCCS data it self is accessed read-only. It will
+# complain and terminate if any of the SCCS files are checked out or
+# if the RCS directory already exists and is nonempty.  If the
+# directory contains snapshot auxiliary data produced by Emacs VC mode
+# for tagging, that will be used too.
+#
+# Date, time, author, comments, and branches, are all preserved.
+# Most SCCS keywords are translated to RCS keywords; it will
+# complain about the exceptions so you can see them.
+#
+# If this tool fails it will tell you why. `rm -rf RCS; unget SCCS/s.*'
+# will recover your initial state.
+#
+# There is one option. With -c you can specify an initial-comments file.
+# Each line should consist of a filename followed by a colon, followed
+# by the RCS initial coment to set for that file.
+#
+# LICENSE:
+#
+# MIT terms apply.  Do anything you like with it.
+#
+# HISTORY:
 #
 # This tool has a complicated history for its size.  It began life as a 
 # script in C-shell written by a hacker named Ken Cox in 1991.
@@ -31,18 +59,8 @@
 # even destroyed as long as you don't tell anyone you wrote it."
 # Those were more innocent days.  This version is released under MIT terms. 
 #
-# Ken's things to note:
-#   + It will NOT delete or alter your ./SCCS history under any circumstances.
-#
-#   + Run in a directory where ./SCCS exists and where you can create ./RCS
-#
-#   + Date, time, author, comments, branches, are all preserved.
-#
-#   + If a command fails somewhere in the middle, it bombs with
-#     a message -- remove what it's done so far and try again.
-#     (`rm -rf RCS; unget SCCS/s.*' should do the job.)
-#     There is no recovery and exit is far from graceful.
-#     If a particular module is hanging you up, consider
+# Ken also said:
+#   + If a particular module is hanging you up, consider
 #     doing it separately; move it from the current area so that
 #     the next run will have a better chance or working.
 #     Also (for the brave only) you might consider hacking