make tg remote idempotent

[topgit.git] / README

diff --git a/README b/README
index 8be0d17ec0e005ce08693505097e4fa9e38d9131..1d3836585b109449fd6475edad5a470700bff802 100644 (file)
--- a/README
+++ b/README
@@ -409,6 +409,14 @@ tg export
        a comma-separated explicit list of branches to export. This
        mode of operation is currently not supported with collapse.
 
+       In '--quilt' mode the patches are named like the originating topgit
+       branch.  So usually they end up in subdirectories of the output
+       directory.  With option '--flatten' the names are mangled such that
+       they end up directly in the output dir (i.e. slashed are substituted by
+       underscores).  With '--numbered' (which implies '--flatten') the patch
+       names get a number as prefix to allow getting the order without
+       consulting the series file, which eases sending out the patches.
+
        Usage: tg export ([--collapse] BRANCH | --quilt DIR)
 
        TODO: Make stripping of non-essential headers configurable