Re: [RFCv2/FYI] git-sequencer.txt

[Stephan Beyer <s-beyer@gmx.net>]

Hi,

On Thu, Jun 12, 2008 at 04:10:42PM +0200,
Jakub Narebski <jnareb@gmail.com> wrote to git@vger.kernel.org:
> > SYNOPSIS
> > --------
> > [verse]
> > 'git-sequencer' [--batch] [--onto=<base>] [--verbose] [<file>]
> > 'git-sequencer' --continue | --skip | --abort | --edit | --status
> 
> I'm not sure if --edit should be mentioned in line with "processing"
> commands: --continue, --skip, --abort and related --status.

Hm I've put it in this line, because it's also an option that is rather
than a command and that takes no other options, as --continue, --skip,
--abort, --status are.

For more information, everybody can scroll down and read the
description.

> > OPTIONS
> > -------
> > <file>::
> > 	Filename of the TODO file.  If omitted, standard input is used.
> > 	See 'TODO FILE FORMAT' below.
> 
> Omitted for standard input, --stdin for standard imput, or special
> filename of '-' for standard input?

In the current spec it is omitted.
In the last one, it was '-'.
My mentors and me discussed also the --stdin/--file approach but put
that down.

> > --onto=<base>::
> > 	Checkout given commit or branch before sequencing.
> > 	If you provide a branch, sequencer will make the provided
> > 	changes on the branch, i.e. the branch will be changed.
> 
> I'm not sure if repeating rebase design is best idea.  But this
> ferature is certainly necessary...

Ok, you say that it's necessary.
I thought this, too, up to Junio's mail I just replied to.

Now I think I can get along without that and let the sequencer user
tools prepare and finish that.
This *could* mean duplicated code, but currently the only tool
that would use this feature is rebase-i.

> > -v::
> > --verbose::
> > 	Be more verbose. [XXX: to be defined more accurately, i.e. print diffstat]
> 
> I think it would be nice to have --quiet mode (which perhaps --batch
> would imply, or perhaps not), which would make git-sequencer to not
> report progress report (i.e. which actions are being done).

Currently I have no idea what should be outputted and what not.
I think I won't care about that for the prototypem but for the builtin
sequencer.

But I add -q/--quiet to the spec, but --batch does not imply it ;)

> > git-sequencer will usually be called by another git porcelain, like
> > linkgit:git-am[1] or linkgit:git-rebase[1].
> 
> Or git-cherry-pick, or git-revert.

Well, I don't know about the others, but for me this is currently not
clear ;-)
The prototype uses git-cherry-pick and I think the first versions of my
builtin will also use it.

Regards,
  Stephan

-- 
Stephan Beyer <s-beyer@gmx.net>, PGP 0x6EDDD207FCC5040F