From: Jonathan Wakely <jwakely@redhat.com>
To: libstdc++@gcc.gnu.org, gcc-patches@gcc.gnu.org
Subject: [committed] libstdc++: Update outdated docs on contributing
Date: Wed, 28 Feb 2024 14:33:13 +0000 [thread overview]
Message-ID: <20240228143357.189407-1-jwakely@redhat.com> (raw)
Pushed to trunk, but I've just noticed it should be https not http.
-- >8 --
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.
---
.../doc/html/manual/appendix_contributing.html | 16 +++++++++-------
.../doc/xml/manual/appendix_contributing.xml | 16 +++++++++-------
2 files changed, 18 insertions(+), 14 deletions(-)
diff --git a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml
index a9196493adc..0dcafcb98af 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>
--
2.43.0
next reply other threads:[~2024-02-28 14:34 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-28 14:33 Jonathan Wakely [this message]
2024-02-28 14:37 ` [committed] libstdc++: Change some URLs in the manual to use https Jonathan Wakely
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=20240228143357.189407-1-jwakely@redhat.com \
--to=jwakely@redhat.com \
--cc=gcc-patches@gcc.gnu.org \
--cc=libstdc++@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).