You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Stefan Sperling <st...@elego.de> on 2008/05/30 12:01:57 UTC
[PATCH]: Extend "Obvious fix" rule in HACKING (was: Re: Jens,
please try to get more peer review)
On Thu, May 29, 2008 at 10:26:47AM -0700, Hyrum K. Wright wrote:
> > -------Original Message-------
> > From: Daniel Shahaf <d....@daniel.shahaf.co.il>
> > Subject: Re: Jens, please try to get more peer review
> > Sent: 29 May '08 10:20
> >
> > Stefan Sperling wrote on Thu, 29 May 2008 at 17:49 +0200:
> > > On Thu, May 29, 2008 at 04:25:00PM +0200, Jens Seidel wrote:
> > > > Most of the time because the 'obvious fix'. If there was any doubt
> > > > I also wrote to this list. I also just forgot adding this flag at
> > > > least once.
> > >
> > > OK. Maybe we should require obvious fixes to be designated as such?
> > > Such as: "Obvious fix: Remove trailing whitespace"
> > >
> > > This would make it more obvious that the obvious fix rule was applied.
> > > Should we update HACKING accordingly?
> > >
> >
> > Maybe "Approved by: obvious fix".
>
> That may confuse the contribulyzer. I think just prefacing the log
> message with "Obvious fix", much the same way people sometimes do with
> work on branches, would be fine. I really don't care how it's done,
> but being explicit about the obvious fix rule being invoked would be a
> good thing.
Should I update HACKING accordingly?
Index: www/hacking.html
===================================================================
--- www/hacking.html (revision 31532)
+++ www/hacking.html (working copy)
@@ -2146,6 +2146,13 @@ may be — in the web pages, API doc
comments, commit messages, etc. We rely on the committer's judgement
to determine what is "obvious"; if you're not sure, just ask.</p>
+<p>Whenever you are invoking the "obvious fix" rule, please say so in
+the <a href="#log-messages">log message</a> of your commit. For example:</p>
+
+<pre>
+ www/hacking.html: Obvious fix: Kill some typos.
+</pre>
+
</div>
</div>
Stefan
Re: [PATCH]: Extend "Obvious fix" rule in HACKING (was: Re: Jens,
please try to get more peer review)
Posted by Daniel Shahaf <d....@daniel.shahaf.co.il>.
Stefan Sperling wrote on Fri, 30 May 2008 at 14:01 +0200:
> On Thu, May 29, 2008 at 10:26:47AM -0700, Hyrum K. Wright wrote:
> > > -------Original Message-------
> > > From: Daniel Shahaf <d....@daniel.shahaf.co.il>
> > > Subject: Re: Jens, please try to get more peer review
> > > Sent: 29 May '08 10:20
> > >
> > > Stefan Sperling wrote on Thu, 29 May 2008 at 17:49 +0200:
> > > > On Thu, May 29, 2008 at 04:25:00PM +0200, Jens Seidel wrote:
> > > > > Most of the time because the 'obvious fix'. If there was any doubt
> > > > > I also wrote to this list. I also just forgot adding this flag at
> > > > > least once.
> > > >
> > > > OK. Maybe we should require obvious fixes to be designated as such?
> > > > Such as: "Obvious fix: Remove trailing whitespace"
> > > >
> > > > This would make it more obvious that the obvious fix rule was applied.
> > > > Should we update HACKING accordingly?
> > > >
> > >
> > > Maybe "Approved by: obvious fix".
> >
> > That may confuse the contribulyzer. I think just prefacing the log
> > message with "Obvious fix", much the same way people sometimes do with
> > work on branches, would be fine. I really don't care how it's done,
> > but being explicit about the obvious fix rule being invoked would be a
> > good thing.
>
> Should I update HACKING accordingly?
>
> Index: www/hacking.html
> ===================================================================
> --- www/hacking.html (revision 31532)
> +++ www/hacking.html (working copy)
> @@ -2146,6 +2146,13 @@ may be — in the web pages, API doc
> comments, commit messages, etc. We rely on the committer's judgement
> to determine what is "obvious"; if you're not sure, just ask.</p>
>
> +<p>Whenever you are invoking the "obvious fix" rule, please say so in
s/are invoking/invoke/ ???
> +the <a href="#log-messages">log message</a> of your commit. For example:</p>
> +
> +<pre>
> + www/hacking.html: Obvious fix: Kill some typos.
^
Missing "*".
> +</pre>
> +
> </div>
>
> </div>
>
Otherwise, +1.
> Stefan
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: [PATCH]: Extend "Obvious fix" rule in HACKING
Posted by Stefan Sperling <st...@elego.de>.
On Fri, May 30, 2008 at 12:33:43PM -0400, C. Michael Pilato wrote:
> Justin Erenkrantz wrote:
> > On Fri, May 30, 2008 at 5:01 AM, Stefan Sperling <st...@elego.de> wrote:
> >> +<p>Whenever you are invoking the "obvious fix" rule, please say so in
> >> +the <a href="#log-messages">log message</a> of your commit. For example:</p>
> >> +
> >> +<pre>
> >> + www/hacking.html: Obvious fix: Kill some typos.
> >> +</pre>
> >
> > It's a bikeshed, but I'd do:
> >
> > ---
> > Obvious fix.
> >
> > * www/hacking.html: Kill some typos.
> > ---
> >
> > I'm not a fan of having the rule conflated with the change
> > description. -- justin
>
> Bikeshed indeed, but sound reasoning nonetheless. +1.
Committed in r31538, with all suggested fixes.
Thanks,
Stefan
Re: [PATCH]: Extend "Obvious fix" rule in HACKING
Posted by "C. Michael Pilato" <cm...@collab.net>.
Justin Erenkrantz wrote:
> On Fri, May 30, 2008 at 5:01 AM, Stefan Sperling <st...@elego.de> wrote:
>> +<p>Whenever you are invoking the "obvious fix" rule, please say so in
>> +the <a href="#log-messages">log message</a> of your commit. For example:</p>
>> +
>> +<pre>
>> + www/hacking.html: Obvious fix: Kill some typos.
>> +</pre>
>
> It's a bikeshed, but I'd do:
>
> ---
> Obvious fix.
>
> * www/hacking.html: Kill some typos.
> ---
>
> I'm not a fan of having the rule conflated with the change
> description. -- justin
Bikeshed indeed, but sound reasoning nonetheless. +1.
--
C. Michael Pilato <cm...@collab.net>
CollabNet <> www.collab.net <> Distributed Development On Demand
Re: [PATCH]: Extend "Obvious fix" rule in HACKING (was: Re: Jens, please try to get more peer review)
Posted by Justin Erenkrantz <ju...@erenkrantz.com>.
On Fri, May 30, 2008 at 5:01 AM, Stefan Sperling <st...@elego.de> wrote:
> +<p>Whenever you are invoking the "obvious fix" rule, please say so in
> +the <a href="#log-messages">log message</a> of your commit. For example:</p>
> +
> +<pre>
> + www/hacking.html: Obvious fix: Kill some typos.
> +</pre>
It's a bikeshed, but I'd do:
---
Obvious fix.
* www/hacking.html: Kill some typos.
---
I'm not a fan of having the rule conflated with the change
description. -- justin
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org