changeset 5256:0b0caffcf175

convert: document filemap.

--- a/hgext/convert/__init__.py	Mon Aug 27 11:56:53 2007 -0700
+++ b/hgext/convert/__init__.py	Mon Aug 27 13:38:16 2007 -0700
@@ -397,6 +397,23 @@
     that use unix logins to identify authors (eg: CVS). One line per author
     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:
+
+      include path/to/file
+
+      exclude path/to/file
+
+      rename from/file to/file
+    
+    The 'include' directive causes a file, or all files under a
+    directory, to be included in the destination repository.  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.
     """
 
     util._encoding = 'UTF-8'