Re: Commit template

[Marcel Holtmann <marcel@holtmann.org>]

Hi Petr,

> > > > > my argument is; not to mess up with the CG: lines created by cg-commit.
> > > > > If you wanna insert a warning then you can of course add additional CG:
> > > > > lines to the commit template.
> > > > 
> > > > Well, i'd argue that anyone making their own commit should be responsible
> > > > for making it look however they like.  Maybe they want to only use only 60
> > > > character wide lines and are tired of seeing the notice about CG: being
> > > > ignored.  Gives the power user a tad more flexibility.   But I really
> > > > don't care much either way.
> > > 
> > > I'm with Sean on this one - implemented (with current cg-commit, and I
> > > used .git/commit-template file instead), committed, pushed out.
> > 
> > then please do a "touch .git/commit-template" and call cg-commit. Now
> > you will see what I mean. It is too easy to screw up.
> 
> So don't touch .git/commit-template. It's not like it stops working, you
> just don't get the top stuff. Which you probably wanted, why would you
> touch .git/commit-template otherwise?

maybe I am the only one who sees a problem here and thinks that it is a
mis-design. Let me try one last time to explain it. We speak here about
end users of Cogito, right? They don't know what is inside the scripts
and how they work. So you tell them that they can create a commit
template that will be presented at every commit time. So lets do it.

---snip---
[PATCH]

Signed-off-by: Marcel Holtmann <marcel@holtmann.org>
---snip---

I would create a file like this and save it as .git/commit-template,
because I don't really know about the CG: lines and actually I don't
really care, because they get deleted anyway. Stupid as I am, I am
expecting now something like this:

---snip---
[PATCH]

Signed-off-by: Marcel Holtmann <marcel@holtmann.org>
CG: -----------------------------------------------------------------------
CG: Lines beginning with the CG: prefix are removed automatically
CG:
CG: Modified files:
CG:    Makefile
CG: -----------------------------------------------------------------------
---snip---

But instead I am getting this:

---snip---

[PATCH]

Signed-off-by: Marcel Holtmann <marcel@holtmann.org>
CG:
CG: Modified files:
CG:    Makefile
CG: -----------------------------------------------------------------------
---snip---

As an end user, what would you say?

> > Why not leave the list of modified files in the hand of the cg-commit
> > and people that wanna extra text inside their commit-template add
> > something like:
> > 
> > CG: ---
> > CG: This is my testing tree, don't commit
> > 
> > This will look much prettier and gives people the same possibilities to
> > change everything.
> 
> But you have extra stuff both before and after the list of modified
> files.

Adding extra CG: lines in a commit template is only good for reminding
you of something, right? Why else would you add them?

> > If you wanna make the modified files list into a full configurable
> > template, then I think you must introduce place holders.
> 
> That's what I was thinking about, actually - @@MODIFIED@@ and such, and
> it replaces _all_ the CG: stuff. Just decided that I have better things
> to do now personally.

I understand that :)

Regards

Marcel