Merge commit 'refs/top-bases/fixes/ensure-worktree' into fixes/ensure-worktree

[topgit.git] / README

diff --git a/README b/README
index c19985f83d54a72728d0c36413ea7b0a03e52d6e..5796112db59a7d09f7897caa600b6f3233054f20 100644 (file)
--- a/README
+++ b/README
@@ -284,8 +284,9 @@ tg patch
        tg patch will be able to automatically send the patches by mail
        or save them to files. (TODO)
 
        tg patch will be able to automatically send the patches by mail
        or save them to files. (TODO)
 

-       TODO: tg patch -i to base at index instead of branch,
-               -w for working tree
+       Options:
+         -i            base patch generation on index instead of branch
+         -w            base patch generation on working tree instead of branch

 
 tg mail
 ~~~~~~~
 
 tg mail
 ~~~~~~~


@@ -409,12 +410,19 @@ tg export
        a comma-separated explicit list of branches to export. This
        mode of operation is currently not supported with collapse.
 
        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
        TODO: Make stripping of [PATCH] and other prefixes configurable
        TODO: --mbox option for other mode of operation
        Usage: tg export ([--collapse] BRANCH | --quilt DIR)
 
        TODO: Make stripping of non-essential headers configurable
        TODO: Make stripping of [PATCH] and other prefixes configurable
        TODO: --mbox option for other mode of operation

-       TODO: prevent exporting of empty patches by the collapse driver

        TODO: -a option to export all branches
        TODO: For quilt exporting, use a temporary branch and remove it when
              done - this would allow producing conflict-less series
        TODO: -a option to export all branches
        TODO: For quilt exporting, use a temporary branch and remove it when
              done - this would allow producing conflict-less series