Hi, On Thu, Jul 15, 2010 at 05:47:40PM +0200, Bernhard R. Link wrote: > * Osamu Aoki <[email protected]> [100715 17:03]: > > Although it may be obvious for you, it is not so easy for a new comer to > > understand git-dpm operation. Especially, which branch you are at for > > each operation. > > Well, it's always hard to guess what people not into something need > to be told to understand it. So any hints about what needs explaining > always helpful. > > > (Beside its commands are too long to type ...) > > That's always a dilemma. Things being too short makes things cryptic, > things to long make it hard to type. I already have some slightly > shorter aliases and perhaps adding very short aliases makes sense, > but I guess it is better to have the speaking command names in the > documentation.
I understand. > > This pristine-tar operation can be done while on any branch, I assume. > > But, the following happens while you are on "master" branch as I > > understand. > > Could you check if > http://git.debian.org/?p=git-dpm/git-dpm.git;a=blob_plain;f=git-dpm.1;hb=7d2638ea9cf786eab0fbe70082f5e1716116186a > makes those things clear? I see finally how it works. This was my major gap. By the way, this automatic branch switching caused me quite a bit of confusion. As I read the following: | --- | .SH DESCRIPTION | Git\-dpm is a tool to handle a debian source package in a git repository. | | Each project contains three branches, a debian branch (\fBmaster\fP/\fIwhatever\fP), | a patched branch (\fBpatched\fP/\fBpatched\-\fP\fIwhaterver\fP) and an upstream | branch (\fBupstream\fP/\fBupstream\-\fP\fIwhatever\fP) and \fBgit\-dpm\fP helps | you store the information in there so you have your changes exportable as quilt | series. | --- I think it may be a good idea to add some explanation along the following at the end of this .SH DESCRIPTION section. (Excuse me not fully groff) | --- | Please note that running git\-dpm switches the checked out branche | automatically depending on the argument used with the git\-dpm command. | * master <-> patched <-> upstream | * whatever <-> patched−whaterver <-> upstream−whatever | --- What do you think. > > I think documentation should just use "master" "upstream" across most > > examples. These upstream-* or patched-* should be introduced as expert > > tricks. This s/upstream-unstable/upstream/g is my another request > > around here. > > As long as there is a way to have it understandable, I'd prefer if > one of the examples includes those branch names. Now I know what you were trying to do with "whatever", I am quite happy this way. Osamu -- To UNSUBSCRIBE, email to [email protected] with a subject of "unsubscribe". Trouble? Contact [email protected]
