public inbox for libstdc++-cvs@sourceware.org
help / color / mirror / Atom feed
From: Jonathan Wakely <redi@gcc.gnu.org>
To: gcc-cvs@gcc.gnu.org, libstdc++-cvs@gcc.gnu.org
Subject: [gcc r12-10223] libstdc++: Update outdated docs on contributing
Date: Mon, 18 Mar 2024 14:03:31 +0000 (GMT)	[thread overview]
Message-ID: <20240318140331.8A5373858417@sourceware.org> (raw)

https://gcc.gnu.org/g:57f4c935f915454879a0d13f0319ba09c9c01309

commit r12-10223-g57f4c935f915454879a0d13f0319ba09c9c01309
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Wed Feb 28 11:24:47 2024 +0000

    libstdc++: Update outdated docs on contributing
    
    We don't want a separate ChangeLog submission now.
    
    libstdc++-v3/ChangeLog:
    
            * doc/xml/manual/appendix_contributing.xml: Replace outdated
            info on ChangeLog entries.
            * doc/html/manual/appendix_contributing.html: Regenerate.
    
    (cherry picked from commit 7c7c937b5e71cf2b53f462cfa6a1df39b5538cee)

Diff:
---
 libstdc++-v3/doc/html/manual/appendix_contributing.html | 16 +++++++++-------
 libstdc++-v3/doc/xml/manual/appendix_contributing.xml   | 16 +++++++++-------
 2 files changed, 18 insertions(+), 14 deletions(-)

diff --git a/libstdc++-v3/doc/html/manual/appendix_contributing.html b/libstdc++-v3/doc/html/manual/appendix_contributing.html
index 8be678eb919..2d04cadd4e8 100644
--- a/libstdc++-v3/doc/html/manual/appendix_contributing.html
+++ b/libstdc++-v3/doc/html/manual/appendix_contributing.html
@@ -79,19 +79,19 @@
 	  bug. For new features a description of the feature and your
 	  implementation.
 	</p></li><li class="listitem"><p>
-	  A ChangeLog entry as plain text; see the various
-	  ChangeLog files for format and content. If you are
-	  using emacs as your editor, simply position the insertion
-	  point at the beginning of your change and hit CX-4a to bring
-	  up the appropriate ChangeLog entry. See--magic! Similar
-	  functionality also exists for vi.
+	  A ChangeLog entry as part of the Git commit message. Check
+	  some recent commits for format and content. The
+	  <code class="filename">contrib/mklog.py</code> script can be used to
+	  generate a ChangeLog template for commit messages. See
+	  <a class="link" href="http://gcc.gnu.org/gitwrite.html" target="_top">Read-write Git access</a>
+	  for scripts and aliases that are useful here.
 	</p></li><li class="listitem"><p>
 	  A testsuite submission or sample program that will
 	  easily and simply show the existing error or test new
 	  functionality.
 	</p></li><li class="listitem"><p>
 	  The patch itself. If you are using the Git repository use
-	  <span class="command"><strong>git diff</strong></span> or <span class="command"><strong>git format-patch</strong></span>
+	  <span class="command"><strong>git show</strong></span> or <span class="command"><strong>git format-patch</strong></span>
 	  to produce a patch;
 	  otherwise, use <span class="command"><strong>diff -cp OLD NEW</strong></span>. If your
 	  version of diff does not support these options, then get the
@@ -102,6 +102,8 @@
 	  patches and related discussion should be sent to the
 	  libstdc++ mailing list. In common with the rest of GCC,
 	  patches should also be sent to the gcc-patches mailing list.
+	  So you could send your email To:libstdc++@gcc.gnu.org and
+	  Cc:gcc-patches@gcc.gnu.org for example.
 	</p></li></ul></div></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="appendix.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="appendix.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="source_organization.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Part IV. 
   Appendices
  </td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top"> Directory Layout and Source Conventions</td></tr></table></div></body></html>
\ No newline at end of file
diff --git a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
index ceb21f4478a..074baf0fb4d 100644
--- a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
+++ b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
@@ -151,12 +151,12 @@
 
       <listitem>
 	<para>
-	  A ChangeLog entry as plain text; see the various
-	  ChangeLog files for format and content. If you are
-	  using emacs as your editor, simply position the insertion
-	  point at the beginning of your change and hit CX-4a to bring
-	  up the appropriate ChangeLog entry. See--magic! Similar
-	  functionality also exists for vi.
+	  A ChangeLog entry as part of the Git commit message. Check
+	  some recent commits for format and content. The
+	  <filename>contrib/mklog.py</filename> script can be used to
+	  generate a ChangeLog template for commit messages. See
+	  <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/gitwrite.html">Read-write Git access</link>
+	  for scripts and aliases that are useful here.
 	</para>
       </listitem>
 
@@ -171,7 +171,7 @@
       <listitem>
 	<para>
 	  The patch itself. If you are using the Git repository use
-	  <command>git diff</command> or <command>git format-patch</command>
+	  <command>git show</command> or <command>git format-patch</command>
 	  to produce a patch;
 	  otherwise, use <command>diff -cp OLD NEW</command>. If your
 	  version of diff does not support these options, then get the
@@ -186,6 +186,8 @@
 	  patches and related discussion should be sent to the
 	  libstdc++ mailing list. In common with the rest of GCC,
 	  patches should also be sent to the gcc-patches mailing list.
+	  So you could send your email To:libstdc++@gcc.gnu.org and
+	  Cc:gcc-patches@gcc.gnu.org for example.
 	</para>
       </listitem>
     </itemizedlist>

                 reply	other threads:[~2024-03-18 14:03 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240318140331.8A5373858417@sourceware.org \
    --to=redi@gcc.gnu.org \
    --cc=gcc-cvs@gcc.gnu.org \
    --cc=libstdc++-cvs@gcc.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).