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

[topgit.git] / README

diff --git a/README b/README
index 9bab4defb385acc3a377750414de8167558c613e..ed8d358c9c85132931c2781498e3205f5d61ce2d 100644 (file)
--- a/README
+++ b/README
@@ -272,6 +272,14 @@ tg depend
 
        TODO: Subcommand for removing dependencies, obviously
 
 
        TODO: Subcommand for removing dependencies, obviously
 

+tg files
+~~~~~~~~
+       List files changed by the current or specified topic branch.
+
+       Options:
+         -i            list files based on index instead of branch
+         -w            list files based on working tree instead of branch
+

 tg info
 ~~~~~~~
        Show a summary information about the current or specified
 tg info
 ~~~~~~~
        Show a summary information about the current or specified


@@ -315,6 +323,10 @@ tg mail
 
        to let `git send-email` ask for confirmation before sending any mail.
 
 
        to let `git send-email` ask for confirmation before sending any mail.
 

+       Options:
+         -i            base patch generation on index instead of branch
+         -w            base patch generation on working tree instead of branch
+

        TODO: 'tg mail patchfile' to mail an already exported patch
        TODO: mailing patch series
        TODO: specifying additional options and addresses on command
        TODO: 'tg mail patchfile' to mail an already exported patch
        TODO: mailing patch series
        TODO: specifying additional options and addresses on command


@@ -327,7 +339,7 @@ tg remote
        and 'git push' to operate on them. (Do NOT use 'git push --all'
        for your pushes - plain 'git push' will do the right thing.)
 
        and 'git push' to operate on them. (Do NOT use 'git push --all'
        for your pushes - plain 'git push' will do the right thing.)
 

-       It takes a mandatory remote name argument, and optional
+       It takes a optional remote name argument, and optional

        '--populate' switch - use that for your origin-style remote,
        it will seed the local topic branch system based on the
        remote topic branches. '--populate' will also make 'tg remote'
        '--populate' switch - use that for your origin-style remote,
        it will seed the local topic branch system based on the
        remote topic branches. '--populate' will also make 'tg remote'


@@ -362,6 +374,10 @@ tg summary
        branches in a machine-readable format.  Feed this to "tsort"
        to get the output from --sort.
 
        branches in a machine-readable format.  Feed this to "tsort"
        to get the output from --sort.
 

+       Options:
+         -i            Use TopGit meta data from the index instead of branch
+         -w            Use TopGit meta data from the working tree instead of branch
+

        TODO: Speed up by an order of magnitude
        TODO: Text graph view
 
        TODO: Speed up by an order of magnitude
        TODO: Text graph view
 


@@ -483,13 +499,15 @@ tg import
 
 tg update
 ~~~~~~~~~
 
 tg update
 ~~~~~~~~~

-       Update the current topic branch wrt. changes in the branches
-       it depends on and remote branches.
+       Update the current or specified topic branch wrt. changes in the
+       branches it depends on and remote branches.

        This is performed in two phases - first,
        changes within the dependencies are merged to the base,
        then the base is merged into the topic branch.
        The output will guide you in case of conflicts.
 
        This is performed in two phases - first,
        changes within the dependencies are merged to the base,
        then the base is merged into the topic branch.
        The output will guide you in case of conflicts.
 

+       After the update the current branch is the specified one.
+

        In case your dependencies are not up-to-date, tg update
        will first recurse into them and update these.
 
        In case your dependencies are not up-to-date, tg update
        will first recurse into them and update these.
 


@@ -512,19 +530,33 @@ tg base
 ~~~~~~~
        Prints the base commit of the current topic branch.  Silently
        exits with exit code 1 if you are not working on a TopGit
 ~~~~~~~
        Prints the base commit of the current topic branch.  Silently
        exits with exit code 1 if you are not working on a TopGit

-       branch.  The following command can be useful to get a summary
-       of the work you have made on a topic branch:
+       branch.

 
 

-               git log --first-parent --no-merges `tg base`..
+tg log
+~~~~~~
+       Prints the git log of the named topgit branch.

 
 

-       (Note: if you have shared the TopGit branch, the above command
-       only lists the commits that were made in the current
-       repository, so you will not see work done by your
-       collaborators.)
+       Note: if you have merged changes from a different repository, this
+       command might not list all interesting commits.

 
 

+tg prev
+~~~~~~~
+       Outputs the direct dependencies for the current or named patch.

 
 

-TODO: tg rename
+       Options:
+         -i            show dependencies based on index instead of branch
+         -w            show dependencies based on working tree instead of branch

 
 

+tg next
+~~~~~~~
+       Outputs all patches which directly depend on the current or
+       named patch.
+
+       Options:
+         -i            show dependencies based on index instead of branch
+         -w            show dependencies based on working tree instead of branch
+
+TODO: tg rename

 
 IMPLEMENTATION
 --------------
 
 IMPLEMENTATION
 --------------