threads / discuss / 12722

stg branch -r instructions

Subject: stg branch -r instructions

## tl;dr

2 messages between Mar 17, 2008 and Mar 17, 2008.

replies: 1people: 2as markdown or json

David Kågedal· Mar 17, 2008, 12:14 UTC · lore

It isn't easy to figure out how to rename a branch in stg from looking at the help texts.

  Usage: stg branch [options] branch-name [commit-id]
  ...
    -r, --rename          rename an existing development branch
So, how do I rename branch A to B?
Reading the source, it appears that you write
  stg branch -r A B

so, the usage string is wrong. In fact, the described usage string is only for the default action to create a new branch.

The optparse library doesn't really make it easy to describe these kinds of options-as-subcommands, so I don't have a patch to fix it right away. I'm not even sure how the result should look.

Maybe it would have been better to have separate stg subcommands?
  stg branch NAME [COMMIT]
  stg list-branches
  stg rename-branch OLD NEW
  ... etc ...
-- 
David Kågedal
Karl Hasselström· Mar 17, 2008, 13:42 UTC · re: David Kågedal · lore

Re: stg branch -r instructions

On 2008-03-17 13:14:07 +0100, David Kågedal wrote:
> so, the usage string is wrong. In fact, the described usage string
> is only for the default action to create a new branch.
Yes, this is far from pretty.
Show 6 quoted lines
> Maybe it would have been better to have separate stg subcommands?
>
>   stg branch NAME [COMMIT]
>   stg list-branches
>   stg rename-branch OLD NEW
>   ... etc ...
My first thought was another level of subcommands:
  stg branch NAME [COMMIT]
  stg branch list
  stg branch rename OLD NEW

But this would create ambiguities -- how do I create a branch called "list"?. One could go with something like

  stg branch NAME [COMMIT]
  stg branch/list
  stg branch/rename OLD NEW

but this is highly non-standard, and would probably confuse every single new user. Perhaps with dashes instead:

  stg branch NAME [COMMIT]
  stg branch-list
  stg branch-rename OLD NEW

Which is essentially what you proposed, but with more regular (and more tab-completion-friendly) names.

-- 
Karl Hasselström, kha@treskal.com
      www.treskal.com/kalle

← back to recent threads