convert: cleanup of filemap help text stable
authorMads Kiilerich <mads@kiilerich.com>
Thu, 08 Jul 2010 15:44:14 +0200
branchstable
changeset 11523 dec57aa0f8ca
parent 11522 eaa7666ad53f
child 11525 f4eddec324b7
child 11527 89ef60af92e9
child 11530 958022f0f1d5
convert: cleanup of filemap help text Clarify that: - Specified paths are matched by comparing name of file or directory. - Line order (thus) doesn't matter. - Rename doesn't imply include.
hgext/convert/__init__.py
tests/test-convert.out
--- a/hgext/convert/__init__.py	Fri Jul 09 14:01:55 2010 +0200
+++ b/hgext/convert/__init__.py	Thu Jul 08 15:44:14 2010 +0200
@@ -77,22 +77,27 @@
     srcauthor=whatever string you want
 
     The filemap is a file that allows filtering and remapping of files
-    and directories. Comment lines start with '#'. Each line can
-    contain one of the following directives::
+    and directories. Each line can contain one of the following
+    directives::
+
+      include path/to/file-or-dir
+
+      exclude path/to/file-or-dir
 
-      include path/to/file
+      rename path/to/source path/to/destination
 
-      exclude path/to/file
-
-      rename from/file to/file
+    Comment lines start with '#'. A specificed path matches if it
+    equals the full relative name of a file or one of its parent
+    directories. The 'include' or 'exclude' directive with the longest
+    matching path applies, so line order does not matter.
 
     The 'include' directive causes a file, or all files under a
     directory, to be included in the destination repository, and the
     exclusion of all other files and directories not explicitly
     included. The 'exclude' directive causes files or directories to
-    be omitted. The 'rename' directive renames a file or directory. To
-    rename from a subdirectory into the root of the repository, use
-    '.' as the path to rename to.
+    be omitted. The 'rename' directive renames a file or directory if
+    is converted. To rename from a subdirectory into the root of the
+    repository, use '.' as the path to rename to.
 
     The splicemap is a file that allows insertion of synthetic
     history, letting you specify the parents of a revision. This is
--- a/tests/test-convert.out	Fri Jul 09 14:01:55 2010 +0200
+++ b/tests/test-convert.out	Thu Jul 08 15:44:14 2010 +0200
@@ -57,21 +57,25 @@
     mapping and the line format is: srcauthor=whatever string you want
 
     The filemap is a file that allows filtering and remapping of files and
-    directories. Comment lines start with '#'. Each line can contain one of
-    the following directives:
+    directories. Each line can contain one of the following directives:
+
+      include path/to/file-or-dir
+
+      exclude path/to/file-or-dir
 
-      include path/to/file
+      rename path/to/source path/to/destination
 
-      exclude path/to/file
-
-      rename from/file to/file
+    Comment lines start with '#'. A specificed path matches if it equals the
+    full relative name of a file or one of its parent directories. The
+    'include' or 'exclude' directive with the longest matching path applies,
+    so line order does not matter.
 
     The 'include' directive causes a file, or all files under a directory, to
     be included in the destination repository, and the exclusion of all other
     files and directories not explicitly included. The 'exclude' directive
     causes files or directories to be omitted. The 'rename' directive renames
-    a file or directory. To rename from a subdirectory into the root of the
-    repository, use '.' as the path to rename to.
+    a file or directory if is converted. To rename from a subdirectory into
+    the root of the repository, use '.' as the path to rename to.
 
     The splicemap is a file that allows insertion of synthetic history,
     letting you specify the parents of a revision. This is useful if you want