]> thyrsus.com Git - rcs-fast-import.git/commitdiff
Update documentation.
authorEric S. Raymond <esr@thyrsus.com>
Sun, 14 Nov 2010 05:59:31 +0000 (00:59 -0500)
committerEric S. Raymond <esr@thyrsus.com>
Sun, 14 Nov 2010 05:59:31 +0000 (00:59 -0500)
rcs-fast-import.xml

index 85e486bc9b1ce54ad4c2502947ec4c5f56addd0f..19f5376eeabe3a72217fd868e4f892478868cdd6 100644 (file)
@@ -22,7 +22,6 @@
   <arg choice='opt'>-v</arg>
   <arg choice='opt'>-u</arg>
   <arg choice='opt'>-l</arg>
-  <arg choice='opt'>-d</arg>
   <arg choice='opt'>-p</arg>
   <arg choice='opt'>-n</arg>
   <arg choice='opt'>-V</arg>
@@ -50,10 +49,6 @@ copies checked out.</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>
@@ -62,13 +57,21 @@ combination with -v.</para>
 previously-created master files; instead, an empty file is checked in
 as the content and the file's RCS state tag is set to "Deleted".  R
 file operations copy corresponding RCS master files <emphasis>without
-</emphasis> deleting the old master file; instead, an empty fiile is checked in as the content and the state set to "Renamed". C operations initialize a new 
-file.</para>
+</emphasis> deleting the old master file; instead, an empty fiile is
+checked in as the content and the state set to "Renamed". C operations
+initialize a new file.</para>
+
+<para>Import-stream branches are mapped to RCS revision branch structure.
+Each RCS master poduced will include a list of branch tags, each of which
+has the value of the corresponding RCS branch.</para>
 </refsect1>
 
 <refsect1 id='bugs'><title>BUGS</title>
 <para>The following limitations are inherent in the RCS format:</para>
 
+<para>RCS has no way to represent merges.  Accordingly, the information
+in import-stream <command>merge</command> commmands is lost.</para>
+
 <para>Annotated tags cannot be preseved in a format readily accessible
 to RCS. This tool deposits them as tagged revisions of a file named
 <filename>ANNOTATED-TAGS</filename> in the toplevel RCS
@@ -84,8 +87,9 @@ unless the -p option was selected.)</para>
 <para>Lightweight tags and branches may cause errors in older RCS versions,
 as they are saved with their full (path) names, including slashes.</para>
 
-<para>Submodule links ("M" entries mith mode 160000) can't be handled;
-the tool will throw an error if it sees one.</para>
+<para>Submodule links ("M" entries mith mode 160000) and symlinks ("M"
+entries mith mode 120000) can't be handled; the tool will throw an
+error if it sees one.</para>
 
 <para>The following are implementation limits of this tool which may be 
 fixed in a future release:</para>
@@ -93,10 +97,6 @@ fixed in a future release:</para>
 <para>This tool has not been tested with RCS versions earlier than
 5.7.  It is likely older versions will throw errors on some tag and
 branch names that are legal in fast-import files.</para>
-
-<para>Branch structure in the input stream is not yet mapped to RCS
-branches.  Round-tripping will fail if the history in the import 
-stream was not linear.</para>
 </refsect1>
 
 <refsect1 id='returns'><title>ERROR RETURNS</title>