convert: more clear documentation of the 'include' default of a 'include .'

At first glance it can be confusing that adding a superfluous include directive
will exclude more files.
This commit is contained in:
Mads Kiilerich 2014-03-19 00:19:54 +01:00
parent 19098ea63d
commit f6b400481f
2 changed files with 10 additions and 8 deletions

View File

@ -101,9 +101,10 @@ def convert(ui, src, dest=None, revmapfile=None, **opts):
longest matching path applies, so line order does not matter. longest matching path applies, so line order does not matter.
The ``include`` directive causes a file, or all files under a The ``include`` directive causes a file, or all files under a
directory, to be included in the destination repository, and the directory, to be included in the destination repository. The default
exclusion of all other files and directories not explicitly if there are no ``include`` statements is to include everything.
included. The ``exclude`` directive causes files or directories to If there are any ``include`` statements, nothing else is included.
The ``exclude`` directive causes files or directories to
be omitted. The ``rename`` directive renames a file or directory if be omitted. The ``rename`` directive renames a file or directory if
it is converted. To rename from a subdirectory into the root of it is converted. To rename from a subdirectory into the root of
the repository, use ``.`` as the path to rename to. the repository, use ``.`` as the path to rename to.

View File

@ -84,11 +84,12 @@
so line order does not matter. so line order does not matter.
The "include" directive causes a file, or all files under a directory, to 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 be included in the destination repository. The default if there are no
files and directories not explicitly included. The "exclude" directive "include" statements is to include everything. If there are any "include"
causes files or directories to be omitted. The "rename" directive renames statements, nothing else is included. The "exclude" directive causes files
a file or directory if it is converted. To rename from a subdirectory into or directories to be omitted. The "rename" directive renames a file or
the root of the repository, use "." as the path to rename to. directory if it 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, 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 letting you specify the parents of a revision. This is useful if you want