]> thyrsus.com Git - rcs-fast-import.git/commitdiff
Add documentation and metadata files.
authorEric S. Raymond <esr@thyrsus.com>
Thu, 11 Nov 2010 15:05:07 +0000 (10:05 -0500)
committerEric S. Raymond <esr@thyrsus.com>
Thu, 11 Nov 2010 15:05:07 +0000 (10:05 -0500)
COPYING [new file with mode: 0644]
Makefile [new file with mode: 0644]
README [new file with mode: 0644]
control [new file with mode: 0644]
rcs-fast-import.xml [new file with mode: 0644]

diff --git a/COPYING b/COPYING
new file mode 100644 (file)
index 0000000..a33e149
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,30 @@
+                       BSD LICENSE
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+Neither name of the this project nor the names of its contributors
+may be used to endorse or promote products derived from this software
+without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
diff --git a/Makefile b/Makefile
new file mode 100644 (file)
index 0000000..5eb34d4
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,32 @@
+#
+# makefile for rcs-fast-export
+#
+VERS=$(shell sed <rcs-fast-export -n -e '/version=\(.*\)/s//\1/p')
+
+SOURCES = README COPYING rcs-fast-export rcs-fast-export.xml Makefile control
+
+all: rcs-fast-export.1
+
+rcs-fast-export.1: rcs-fast-export.xml
+       xmlto man rcs-fast-export.xml
+
+rcs-fast-export.html: rcs-fast-export.xml
+       xmlto html-nochunks rcs-fast-export.xml
+
+clean:
+       rm -f  *~ *.1 *.html *.tar.gz MANIFEST SHIPPER.*
+       rm -fr .rs* typescript test/typescript
+
+rcs-fast-export-$(VERS).tar.gz: $(SOURCES) rcs-fast-export.1 
+       @ls $(SOURCES)rcs-fast-export.1 | sed s:^:rcs-fast-export-$(VERS)/: >MANIFEST
+       @(cd ..; ln -s rcs-fast-export rcs-fast-export-$(VERS))
+       (cd ..; tar -czvf rcs-fast-export/rcs-fast-export-$(VERS).tar.gz `cat rcs-fast-export/MANIFEST`)
+       @(cd ..; rm rcs-fast-export-$(VERS))
+
+version:
+       @echo $(VERS)
+
+dist: rcs-fast-export-$(VERS).tar.gz
+
+release: rcs-fast-export-$(VERS).tar.gz rcs-fast-export.html
+       shipper -u -m -t; make clean
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..47e13d8
--- /dev/null
+++ b/README
@@ -0,0 +1,12 @@
+               rcs-fast-import
+
+rcs-fast-import unpacks a git fast-import stream into an RCS file tree
+
+The metadata in modern DVCSes can't really be stuffed back into RCS,
+but this tool makes a valiant effort and may occasionally be useful
+for extracting the revision histories of individual files from a
+project history.
+
+It keeps the revision structure, comments, authorship dates, and tag names.
+It loses tag dates and comments and authorship information; commits are
+recorded as though they were from the user invoking it.
diff --git a/control b/control
new file mode 100644 (file)
index 0000000..a3ebf91
--- /dev/null
+++ b/control
@@ -0,0 +1,13 @@
+# This is not a real Debian control file
+# It's project metadata for the shipper tool
+
+Package: rcs-fast-export
+
+Description: unpack a git fast-import stream into an RCS file tree
+ The metadata in modern DVCSes can't really be stuffed back into RCS,
+ but this tool makes a valiant effort and may be useful for extracting
+ the revision histories of individual files from a project history.
+
+Homepage: http://www.catb.org/~esr/rcs-fast-export
+
+XBS-Project-Tag-List: version control, git
diff --git a/rcs-fast-import.xml b/rcs-fast-import.xml
new file mode 100644 (file)
index 0000000..279ce5f
--- /dev/null
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC 
+   "-//OASIS//DTD DocBook XML V4.1.2//EN"
+   "docbook/docbookx.dtd">
+<refentry id='rcs-fast-export.1'>
+<refmeta>
+<refentrytitle>rcs-fast-export</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo class='date'>Nov 11 2010</refmiscinfo>
+<refmiscinfo class='productname'>rcs-fast-export</refmiscinfo>
+<refmiscinfo class='source'>rcs-fast-export</refmiscinfo>
+<refmiscinfo class='manual'>Development Tools</refmiscinfo>
+</refmeta>
+<refnamediv id='name'>
+<refname>rcs-fast-export</refname>
+<refpurpose>surgical operations on repositories</refpurpose>
+</refnamediv>
+<refsynopsisdiv id='synopsis'>
+
+<cmdsynopsis>
+  <command>rcs-fast-export</command>
+  <arg choice='opt'>-v</arg>
+  <arg choice='opt'>-u</arg>
+  <arg choice='opt'>-l</arg>
+  <arg choice='opt'>-d</arg>
+  <arg choice='opt'>-n</arg>
+  <arg choice='opt'>-V</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id='description'><title>DESCRIPTION</title>
+
+<para>This tool breaks the content of a git-fast-import stream on
+stdin into individual RCS master files in RCS subdirectories of the
+corresponding directory structure.</para>
+
+<para>With the -v option, emit a twirling-baton prompt during stream read, and
+progress messages during RCS writes.</para>
+
+<para>With the -l option, check out and lock all resulting files at their latest
+revisions; with the -u option, check out but do not lock.</para>
+
+<para>The -V option displays the program version number and exits. -? displays
+this help and exits.</para>
+
+<para>The -d option enables delete operations in the the input
+stream. Normally, delete operations in the input stream are ignored so
+as to maximize access to the unpacked history.</para>
+
+<para>The -n option sets dry-run mode; parse the import stream, then go through
+all logic other than actually creating files.  Useful for debugging in
+combination with -v.</para>
+
+<para>R file operations rename corresponding RCS master files; C file operations
+copy them.</para>
+
+<para>If D, R, or C operations are present, the conversion will not
+round-trip properly (that is the file structure after ,
+rcs-fast-export | rcs-fast-import won't be an exact copy) with
+differences near deleted, renamed, and copied files.</para>
+
+<para>Warning: All tag metadata other than the name will be lost.  The date
+imputed to commits is from the author metadata if that exists, otherwise
+from the committer metadata. Committer and author information is lost.</para>
+</refsect1>
+
+<refsect1 id='returns'><title>ERROR RETURNS</title>
+<para>Returns 1 on any error, 0 otherwise.</para>
+</refsect1>
+
+<refsect1 id='author'><title>AUTHOR</title>
+
+<para>Eric S. Raymond <email>esr@thyrsus.com</email>; project page at <ulink
+url='http://www.catb.org/~esr/rcs-fast-export'>http://www.catb.org/~esr/rcs-fast-export</ulink>.</para>
+</refsect1>
+</refentry>