This is the mail archive of the gcc@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: ChangeLog conventions (was: hppa-linux regressions and 3.2.2 release)


> Given that this seems to be consensus (with Gaby, Geoff,...) using and/or
> preferring it as well, would (one of) you volunteer to submit this as a
> suggestion for
>
>   http://www.gnu.org/prep/standards_toc.html
>
> or our codingconventions.html?

Something like this:

Index: codingconventions.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/codingconventions.html,v
retrieving revision 1.18
diff -u -r1.18 codingconventions.html
--- codingconventions.html	7 Dec 2002 13:51:44 -0000	1.18
+++ codingconventions.html	11 Feb 2003 10:14:49 -0000
@@ -56,7 +56,11 @@
 particular, descriptions of the purpose of code and changes should go
 in comments rather than the ChangeLog, though a single line overall
 description of the changes may be useful above the ChangeLog entry for
-a large batch of changes.</p>
+a large batch of changes. For changes that are backported from another
+branch to the working one, we recommend to use a single entry whose
+body contains a verbatim copy of the whole (header+body) entries
+describing the changes on the source branch, possibly preceded by a
+single line overall description of the changes.</p>
 
 <p>There is no established convention on when ChangeLog entries are to
 be made for testsuite changes; see messages <a

-- 
Eric Botcazou


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]