public inbox for libstdc++@gcc.gnu.org
 help / color / mirror / Atom feed
From: Jonathan Wakely <jwakely@redhat.com>
To: Gerald Pfeifer <gerald@pfeifer.com>
Cc: gcc-patches@gcc.gnu.org, libstdc++@gcc.gnu.org
Subject: Re: [pushed] wwwdocs: codingconventions: Update upstream instructions for libstdc++
Date: Fri, 27 Jan 2023 12:21:12 +0000	[thread overview]
Message-ID: <Y9PBuCSn7Z3DcxqC@redhat.com> (raw)
In-Reply-To: <20230127001617.CE64D33E9E@hamza.pair.com>

[-- Attachment #1: Type: text/plain, Size: 316 bytes --]

On 27/01/23 01:16 +0100, Gerald Pfeifer wrote:
>Jonathan (or some other libstdc++ developer), would you mind having a
>look at that section of https://gcc.gnu.org/codingconventions.html to
>see whether we should do further changes?

Oh wow, it's all wrong. I've pushed the patch below, thanks for
pointing it out.



[-- Attachment #2: patch.txt --]
[-- Type: text/x-patch, Size: 1534 bytes --]

commit 17f88fe2b73fe50b1831ece5dd40bf29151899ab
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Fri Jan 27 12:13:42 2023 +0000

    Replace outdated info about libstdc++-v3/doc files

diff --git a/htdocs/codingconventions.html b/htdocs/codingconventions.html
index 24365815..7e2a092d 100644
--- a/htdocs/codingconventions.html
+++ b/htdocs/codingconventions.html
@@ -754,13 +754,13 @@ autoconf-based configury is a local GCC invention.  Changes to zlib
 outside the build system are discouraged, and should be sent upstream
 first. </li>
 
-<li>libstdc++-v3:  In docs/doxygen, comments in *.cfg.in are
-partially autogenerated from <a href="https://www.doxygen.nl">the
-Doxygen tool</a>.  In docs/html, 
-the 27_io/binary_iostream_* files are copies of Usenet postings, and most
-of the files in 17_intro are either copied from elsewhere in GCC or the
-FSF website, or are autogenerated.  These files should not be changed
-without prior permission, if at all.</li>
+<li>libstdc++-v3:  The doc/doxygen/user.cfg.in file is partially autogenerated
+from <a href="https://www.doxygen.nl">the Doxygen tool</a> (and regenerated
+using <tt>doxygen -u</tt>).
+The files in doc/html are generated from the Docbook sources in doc/xml
+and should not be changed manually.
+The files in doc/xml/gnu are based on the GNU licenses and should not
+be changed without prior permission, if at all.</li>
 
 <li>libgcc/config/libbid: The master sources come from Intel BID library
 <a href="https://netlib.org/misc/intel/">Intel BID library</a>. 

      reply	other threads:[~2023-01-27 12:21 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-27  0:16 Gerald Pfeifer
2023-01-27 12:21 ` Jonathan Wakely [this message]

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=Y9PBuCSn7Z3DcxqC@redhat.com \
    --to=jwakely@redhat.com \
    --cc=gcc-patches@gcc.gnu.org \
    --cc=gerald@pfeifer.com \
    --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).