You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by kf...@collab.net on 2004/10/04 14:28:14 UTC
RFC: change to HACKING guidelines on log messages
In r11227, I made the following change:
* HACKING (Writing Log Messages): Specify looser guidelines for
translation or documentation log messages, based on feedback from
Grzegorz Adam Hankiewicz <gr...@titanium.sabren.com> in thread:
http://subversion.tigris.org/servlets/BrowseList?\
list=dev&by=thread&from=202584
In particular: <20...@hankiewicz.datanet.co.uk>
[see the diff at the end of this mail]
Since this might be controversial, I wanted to solicit feedback from
other developers here. If there isn't consensus that this loosening
of the log message guidelines is a Good Thing, then we should discuss,
and I'll certainly be happy to revert if necessary.
Thanks,
-Karl
Index: HACKING
===================================================================
--- HACKING (revision 11226)
+++ HACKING (revision 11227)
@@ -911,7 +911,8 @@
Writing log messages
====================
-Certain guidelines should be adhered to when writing log messages:
+Certain guidelines should be adhered to when writing log messages for
+code changes:
Make a log message for every change. The value of the log becomes
much less if developers cannot rely on its completeness. Even if
@@ -1041,7 +1042,16 @@
considerate of your fellow developers. (Also, run "svn log" to see
how others have been writing their log entries.)
+Log messages for documentation or translation have somewhat looser
+guidelines. The requirement to name every symbol obviously does not
+apply, and if the change is just one more increment in a continuous
+process such as translation, it's not even necessary to name every
+file. Just briefly summarize the change, for example: "More work on
+Malagasy translation of the book." When you finish a distinct stage
+of work, note it in the log message, for example: "Finish Chapter 3 of
+Malagasy book translation."
+
Patch submission guidelines
===========================
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: RFC: change to HACKING guidelines on log messages
Posted by Grzegorz Adam Hankiewicz <gr...@titanium.sabren.com>.
On 2004-10-09, kfogel@collab.net wrote:
> Grzegorz Adam Hankiewicz <gr...@titanium.sabren.com> writes:
> > I would only add a note to make log messages in English even for
> > translated documents. It allows English only speaking people
> > to review the changes and maybe decide to revert them if they
> > are incorrect, not appropriate or simply better in another place.
>
> Looks good to me (don't forget two spaces after the period,
> though).
>
> Want to commit it?
Commited with two spaces.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: RFC: change to HACKING guidelines on log messages
Posted by Erik Huelsmann <e....@gmx.net>.
> On 2004-10-09, kfogel@collab.net wrote:
> > Grzegorz Adam Hankiewicz <gr...@titanium.sabren.com> writes:
> > > I would only add a note to make log messages in English even for
> > > translated documents. It allows English only speaking people
> > > to review the changes and maybe decide to revert them if they
> > > are incorrect, not appropriate or simply better in another place.
> >
> > Looks good to me (don't forget two spaces after the period,
> > though).
>
> This is something I had not noticed before, and couldn't find it in
> HACKING. Is it a convention you have for every kind of text document?
Yes. If you use 2 spaces, then you can use emacs sentence navigation
commands.
> > Want to commit it?
>
> I thought my access would be restricted to doc/translations/spanish/*.
You are correct, but you can commit anywhere as soon as a partial committer
for that area (or full committer ofcourse) sanctions your commit. Please
state in your commit who sanctioned it if you commit outside of your commit
area.
HTH,
Erik.
--
GMX ProMail mit bestem Virenschutz http://www.gmx.net/de/go/mail
+++ Empfehlung der Redaktion +++ Internet Professionell 10/04 +++
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: RFC: change to HACKING guidelines on log messages
Posted by kf...@collab.net.
Grzegorz Adam Hankiewicz <gr...@titanium.sabren.com> writes:
> This is something I had not noticed before, and couldn't find it in
> HACKING. Is it a convention you have for every kind of text document?
Yes, though not strictly enforced. The two-spaces rule helps those of
us who use sentence-motion commands in our editors.
> > Want to commit it?
>
> I thought my access would be restricted to doc/translations/spanish/*.
Well, if someone with commit access to area A approves you to make a
commit in area A, then you can make that commit in area A :-). Just
mention the name of the committer who approved it, in your log message.
The long-term goal is that partial committers can gradually expand
their areas. For example, if you post 3 patches that fix typos or
other problems in documentation, and they all get approved for commit,
then eventually someone will propose (privately, among the other full
committers) that your commit rights be expanded to include all
documentation. No one will disagree, and so your access will be
expanded.
Thus, we're "carefully loose" about the restrictions.
-Karl
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: RFC: change to HACKING guidelines on log messages
Posted by Grzegorz Adam Hankiewicz <gr...@titanium.sabren.com>.
On 2004-10-09, kfogel@collab.net wrote:
> Grzegorz Adam Hankiewicz <gr...@titanium.sabren.com> writes:
> > I would only add a note to make log messages in English even for
> > translated documents. It allows English only speaking people
> > to review the changes and maybe decide to revert them if they
> > are incorrect, not appropriate or simply better in another place.
>
> Looks good to me (don't forget two spaces after the period,
> though).
This is something I had not noticed before, and couldn't find it in
HACKING. Is it a convention you have for every kind of text document?
> Want to commit it?
I thought my access would be restricted to doc/translations/spanish/*.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: RFC: change to HACKING guidelines on log messages
Posted by kf...@collab.net.
Grzegorz Adam Hankiewicz <gr...@titanium.sabren.com> writes:
> I would only add a note to make log messages in English even for
> translated documents. It allows English only speaking people to
> review the changes and maybe decide to revert them if they are
> incorrect, not appropriate or simply better in another place.
Looks good to me (don't forget two spaces after the period, though).
Want to commit it?
-Karl
> Index: HACKING
> ===================================================================
> --- HACKING (revision 11255)
> +++ HACKING (working copy)
> @@ -1049,7 +1049,9 @@
> file. Just briefly summarize the change, for example: "More work on
> Malagasy translation of the book." When you finish a distinct stage
> of work, note it in the log message, for example: "Finish Chapter 3 of
> -Malagasy book translation."
> +Malagasy book translation.". Please write your log messages in English
> +so everybody involved in the project maintenance understands what type
> +of changes were made and possibly suggest changes on them.
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
> For additional commands, e-mail: dev-help@subversion.tigris.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: RFC: change to HACKING guidelines on log messages
Posted by Grzegorz Adam Hankiewicz <gr...@titanium.sabren.com>.
On 2004-10-04, kfogel@collab.net wrote:
> Since this might be controversial, I wanted to solicit feedback from
> other developers here. If there isn't consensus that this loosening
> of the log message guidelines is a Good Thing, then we should discuss,
> and I'll certainly be happy to revert if necessary.
I would only add a note to make log messages in English even for
translated documents. It allows English only speaking people to
review the changes and maybe decide to revert them if they are
incorrect, not appropriate or simply better in another place.
Index: HACKING
===================================================================
--- HACKING (revision 11255)
+++ HACKING (working copy)
@@ -1049,7 +1049,9 @@
file. Just briefly summarize the change, for example: "More work on
Malagasy translation of the book." When you finish a distinct stage
of work, note it in the log message, for example: "Finish Chapter 3 of
-Malagasy book translation."
+Malagasy book translation.". Please write your log messages in English
+so everybody involved in the project maintenance understands what type
+of changes were made and possibly suggest changes on them.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org