This is the mail archive of the gcc-patches@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: PATCH: java/contrib.html


On Sat, 26 Jul 2003, Joseph S. Myers wrote:
>> -    <p>If your change fixes a PR, put the text (e.g.)
>> -      ``<tt>Fixes PR java/58</tt>'' into the ChangeLog entry and into the
>> -      cvs commit message.  This will cause an automatic message to be
> This also ought to be documented (with the current syntax accepted by
> log_accum_bugzillafied), in the ChangeLogs section of
> codingconventions.html (as it's relevant to people without CVS write
> access who are writing ChangeLog entries).

I was sure that we already had it there, but apparently I just recalled
my repeated requests to move it there. :-(

While I was at it, I also compressed the docs a bit; we really should try
to make them shorter/keep them short.

Gerald

Compress notes on ChangeLogs a bit. Document our convention of including
releated PR numbers in ChangeLog entries.

Index: codingconventions.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/codingconventions.html,v
retrieving revision 1.26
diff -u -3 -p -r1.26 codingconventions.html
--- codingconventions.html	26 Jul 2003 18:53:29 -0000	1.26
+++ codingconventions.html	30 Jul 2003 12:07:59 -0000
@@ -45,10 +45,9 @@ maintained and kept up to date.  In part
 <h2>ChangeLogs</h2>

 <p>GCC requires ChangeLog entries for documentation changes (see <a
-href="http://gcc.gnu.org/ml/gcc-bugs/1998-03/msg00564.html";>message</a>),
-though for changes to the GCC web pages (as opposed to the java and
-libstdc++-v3 ones) there is no appropriate ChangeLog file and the CVS
-logs suffice.</p>
+href="http://gcc.gnu.org/ml/gcc-bugs/1998-03/msg00564.html";>message</a>);
+for the GCC web pages (apart from the java and libstdc++-v3 ones) we the
+CVS commit logs are sufficient.</p>

 <p>See also what the <a
 href="http://www.gnu.org/prep/standards_toc.html";>GNU Coding
@@ -68,6 +67,9 @@ be made for testsuite changes; see messa
 href="http://gcc.gnu.org/ml/gcc/2000-09/msg00287.html";>1</a> and <a
 href="http://gcc.gnu.org/ml/gcc/2000-09/msg00290.html";>2</a>.</p>

+<p>If your change fixes a PR, put <code>PR java/58<code> (where
+<code>java/58</code> is the actual number of the PR) at the top
+of the ChangeLog entry.</p>

 <h2>Portability</h2>


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