diff mbox series

libstdc++: Update incorrect statement about mainline in docs

Message ID 20220414102911.681186-1-jwakely@redhat.com
State New
Headers show
Series libstdc++: Update incorrect statement about mainline in docs | expand

Commit Message

Jonathan Wakely April 14, 2022, 10:29 a.m. UTC
This fixes some misleading text in the libstdc++ manual that says the
docs for the gcc-11 branch refer to mainline.

Richi, is this OK for the gcc-11 branch now? It's been wrong for 11.1
and 11.2, but it would still be nice to fix.

-- >8 --

libstdc++-v3/ChangeLog:

	* doc/xml/manual/status_cxx1998.xml: Refer to GCC 11 not
	mainline.
	* doc/xml/manual/status_cxx2011.xml: Likewise.
	* doc/xml/manual/status_cxx2014.xml: Likewise.
	* doc/xml/manual/status_cxx2017.xml: Likewise.
	* doc/xml/manual/status_cxx2020.xml: Likewise.
	* doc/xml/manual/status_cxxtr1.xml: Likewise.
	* doc/xml/manual/status_cxxtr24733.xml: Likewise.
	* doc/html/manual/status.html: Regenerate.
---
 libstdc++-v3/doc/html/manual/status.html      | 24 ++++++++-----------
 .../doc/xml/manual/status_cxx1998.xml         |  3 +--
 .../doc/xml/manual/status_cxx2011.xml         |  3 +--
 .../doc/xml/manual/status_cxx2014.xml         |  4 ++--
 .../doc/xml/manual/status_cxx2017.xml         |  4 ++--
 .../doc/xml/manual/status_cxx2020.xml         |  4 ++--
 libstdc++-v3/doc/xml/manual/status_cxxtr1.xml |  3 +--
 .../doc/xml/manual/status_cxxtr24733.xml      |  3 +--
 8 files changed, 20 insertions(+), 28 deletions(-)

Comments

Richard Biener April 14, 2022, 10:36 a.m. UTC | #1
On Thu, 14 Apr 2022, Jonathan Wakely wrote:

> This fixes some misleading text in the libstdc++ manual that says the
> docs for the gcc-11 branch refer to mainline.
> 
> Richi, is this OK for the gcc-11 branch now? It's been wrong for 11.1
> and 11.2, but it would still be nice to fix.

Yes, it's OK.  I notice the same problem exists on the GCC 10 branch
but GCC 9 at least mentions GCC 9 once ;)

Richard.

> -- >8 --
> 
> libstdc++-v3/ChangeLog:
> 
> 	* doc/xml/manual/status_cxx1998.xml: Refer to GCC 11 not
> 	mainline.
> 	* doc/xml/manual/status_cxx2011.xml: Likewise.
> 	* doc/xml/manual/status_cxx2014.xml: Likewise.
> 	* doc/xml/manual/status_cxx2017.xml: Likewise.
> 	* doc/xml/manual/status_cxx2020.xml: Likewise.
> 	* doc/xml/manual/status_cxxtr1.xml: Likewise.
> 	* doc/xml/manual/status_cxxtr24733.xml: Likewise.
> 	* doc/html/manual/status.html: Regenerate.
> ---
>  libstdc++-v3/doc/html/manual/status.html      | 24 ++++++++-----------
>  .../doc/xml/manual/status_cxx1998.xml         |  3 +--
>  .../doc/xml/manual/status_cxx2011.xml         |  3 +--
>  .../doc/xml/manual/status_cxx2014.xml         |  4 ++--
>  .../doc/xml/manual/status_cxx2017.xml         |  4 ++--
>  .../doc/xml/manual/status_cxx2020.xml         |  4 ++--
>  libstdc++-v3/doc/xml/manual/status_cxxtr1.xml |  3 +--
>  .../doc/xml/manual/status_cxxtr24733.xml      |  3 +--
>  8 files changed, 20 insertions(+), 28 deletions(-)
> 
> diff --git a/libstdc++-v3/doc/xml/manual/status_cxx1998.xml b/libstdc++-v3/doc/xml/manual/status_cxx1998.xml
> index 792272bcf26..f1be6667cd7 100644
> --- a/libstdc++-v3/doc/xml/manual/status_cxx1998.xml
> +++ b/libstdc++-v3/doc/xml/manual/status_cxx1998.xml
> @@ -18,8 +18,7 @@ This status table is based on the table of contents of ISO/IEC 14882:2003.
>  </para>
>  
>  <para>
> -This section describes the C++ support in mainline GCC, not in any
> -particular release.
> +This section describes the C++ support in the GCC 11 release series.
>  </para>
>  
>  <!-- Status is Yes or No, Broken/Partial-->
> diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2011.xml b/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
> index 88844f8f0cc..e06f2479763 100644
> --- a/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
> +++ b/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
> @@ -34,8 +34,7 @@ This status table is based on the table of contents of ISO/IEC 14882:2011.
>  </para>
>  
>  <para>
> -This section describes the C++11 support in mainline GCC, not in any
> -particular release.
> +This section describes the C++11 support in the GCC 11 release series.
>  </para>
>  
>  <!-- Status is Yes or No, Broken/Partial-->
> diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2014.xml b/libstdc++-v3/doc/xml/manual/status_cxx2014.xml
> index 5dc287707d8..deb15c7f0d5 100644
> --- a/libstdc++-v3/doc/xml/manual/status_cxx2014.xml
> +++ b/libstdc++-v3/doc/xml/manual/status_cxx2014.xml
> @@ -29,8 +29,8 @@ since C++11 and the implementation is complete.
>  </para>
>  
>  <para>
> -This section describes the C++14 and library TS support in mainline GCC,
> -not in any particular release.
> +This section describes the C++14 and library TS support in the GCC 11
> +release series.
>  </para>
>  
>  <!-- Status is Yes or No, Broken/Partial-->
> diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2017.xml b/libstdc++-v3/doc/xml/manual/status_cxx2017.xml
> index 11372bb28b3..52bbce0a2be 100644
> --- a/libstdc++-v3/doc/xml/manual/status_cxx2017.xml
> +++ b/libstdc++-v3/doc/xml/manual/status_cxx2017.xml
> @@ -23,8 +23,8 @@ since that release.
>  </para>
>  
>  <para>
> -This section describes the C++17 and library TS support in mainline GCC,
> -not in any particular release.
> +This section describes the C++17 and library TS support in the GCC 11
> +release series.
>  </para>
>  
>  <para>
> diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2020.xml b/libstdc++-v3/doc/xml/manual/status_cxx2020.xml
> index 9e9777ea85f..411a337c534 100644
> --- a/libstdc++-v3/doc/xml/manual/status_cxx2020.xml
> +++ b/libstdc++-v3/doc/xml/manual/status_cxx2020.xml
> @@ -20,8 +20,8 @@ presence of the required flag.
>  </para>
>  
>  <para>
> -This section describes the C++20 and library TS support in mainline GCC,
> -not in any particular release.
> +This section describes the C++20 and library TS support in the GCC 11
> +release series.
>  </para>
>  
>  <para>
> diff --git a/libstdc++-v3/doc/xml/manual/status_cxxtr1.xml b/libstdc++-v3/doc/xml/manual/status_cxxtr1.xml
> index 021cb6394a7..6533857ba12 100644
> --- a/libstdc++-v3/doc/xml/manual/status_cxxtr1.xml
> +++ b/libstdc++-v3/doc/xml/manual/status_cxxtr1.xml
> @@ -22,8 +22,7 @@ In this implementation the header names are prefixed by
>  </para>
>  
>  <para>
> -This page describes the TR1 support in mainline GCC, not in any particular
> -release.
> +This page describes the TR1 support in the GCC 11 release series.
>  </para>
>  
>  <!-- Status is Yes or No, Broken/Partial-->
> diff --git a/libstdc++-v3/doc/xml/manual/status_cxxtr24733.xml b/libstdc++-v3/doc/xml/manual/status_cxxtr24733.xml
> index 139b94442e8..4b6d64c7c6a 100644
> --- a/libstdc++-v3/doc/xml/manual/status_cxxtr24733.xml
> +++ b/libstdc++-v3/doc/xml/manual/status_cxxtr24733.xml
> @@ -16,8 +16,7 @@ decimal floating-point arithmetic
>  </para>
>  
>  <para>
> -This page describes the TR 24733 support in mainline GCC, not in any
> -particular release.
> +This page describes the TR 24733 support in the GCC 11 release series.
>  </para>
>  
>  <!-- Status is Yes or No, Broken/Partial-->
>
Jonathan Wakely April 14, 2022, 10:44 a.m. UTC | #2
On Thu, 14 Apr 2022 at 11:36, Richard Biener <rguenther@suse.de> wrote:
>
> On Thu, 14 Apr 2022, Jonathan Wakely wrote:
>
> > This fixes some misleading text in the libstdc++ manual that says the
> > docs for the gcc-11 branch refer to mainline.
> >
> > Richi, is this OK for the gcc-11 branch now? It's been wrong for 11.1
> > and 11.2, but it would still be nice to fix.
>
> Yes, it's OK.  I notice the same problem exists on the GCC 10 branch
> but GCC 9 at least mentions GCC 9 once ;)

Yes, I fixed it for gcc-9.3.0, but forgot to do it for gcc-10 and gcc-11.

I pushed r10-10534 to fix gcc-10 (since that's open for doc changes)
and have now pushed r11-9881
as well.

Maybe this year I'll remember to do it for gcc-12 after we branch from trunk!
Richard Biener April 14, 2022, 10:55 a.m. UTC | #3
On Thu, 14 Apr 2022, Jonathan Wakely wrote:

> On Thu, 14 Apr 2022 at 11:36, Richard Biener <rguenther@suse.de> wrote:
> >
> > On Thu, 14 Apr 2022, Jonathan Wakely wrote:
> >
> > > This fixes some misleading text in the libstdc++ manual that says the
> > > docs for the gcc-11 branch refer to mainline.
> > >
> > > Richi, is this OK for the gcc-11 branch now? It's been wrong for 11.1
> > > and 11.2, but it would still be nice to fix.
> >
> > Yes, it's OK.  I notice the same problem exists on the GCC 10 branch
> > but GCC 9 at least mentions GCC 9 once ;)
> 
> Yes, I fixed it for gcc-9.3.0, but forgot to do it for gcc-10 and gcc-11.
> 
> I pushed r10-10534 to fix gcc-10 (since that's open for doc changes)
> and have now pushed r11-9881
> as well.
> 
> Maybe this year I'll remember to do it for gcc-12 after we branch from trunk!

Add an entry to branching.html!

Richard.
Jonathan Wakely April 14, 2022, 4:09 p.m. UTC | #4
On Thu, 14 Apr 2022 at 11:55, Richard Biener <rguenther@suse.de> wrote:
>
> On Thu, 14 Apr 2022, Jonathan Wakely wrote:
>
> > On Thu, 14 Apr 2022 at 11:36, Richard Biener <rguenther@suse.de> wrote:
> > >
> > > On Thu, 14 Apr 2022, Jonathan Wakely wrote:
> > >
> > > > This fixes some misleading text in the libstdc++ manual that says the
> > > > docs for the gcc-11 branch refer to mainline.
> > > >
> > > > Richi, is this OK for the gcc-11 branch now? It's been wrong for 11.1
> > > > and 11.2, but it would still be nice to fix.
> > >
> > > Yes, it's OK.  I notice the same problem exists on the GCC 10 branch
> > > but GCC 9 at least mentions GCC 9 once ;)
> >
> > Yes, I fixed it for gcc-9.3.0, but forgot to do it for gcc-10 and gcc-11.
> >
> > I pushed r10-10534 to fix gcc-10 (since that's open for doc changes)
> > and have now pushed r11-9881
> > as well.
> >
> > Maybe this year I'll remember to do it for gcc-12 after we branch from trunk!
>
> Add an entry to branching.html!

Like this? OK for wwwdocs?
commit 7789dd25ce48039d9b6459340051e403f1f8b309
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Thu Apr 14 17:08:34 2022 +0100

    Update branching.html with reminder for libstdc++ docs

diff --git a/htdocs/branching.html b/htdocs/branching.html
index f30a47e1..ff28eb51 100644
--- a/htdocs/branching.html
+++ b/htdocs/branching.html
@@ -40,6 +40,9 @@ git push origin tag basepoints/gcc-11
 for the next major release in the <code>wwwdocs</code> repository and
 populate it with initial copies of <code>changes.html</code> and
 <code>criteria.html</code>.</li>
+
+<li>Libstdc++ maintainers should update references to "mainline GCC" in
+<code>libstdc++-v3/doc/xml/manual/status_cxx*.xml</code>.</li>
 </ol>
 
 <h2>Web Site Updates</h2>
Richard Biener April 19, 2022, 7:01 a.m. UTC | #5
On Thu, 14 Apr 2022, Jonathan Wakely wrote:

> On Thu, 14 Apr 2022 at 11:55, Richard Biener <rguenther@suse.de> wrote:
> >
> > On Thu, 14 Apr 2022, Jonathan Wakely wrote:
> >
> > > On Thu, 14 Apr 2022 at 11:36, Richard Biener <rguenther@suse.de> wrote:
> > > >
> > > > On Thu, 14 Apr 2022, Jonathan Wakely wrote:
> > > >
> > > > > This fixes some misleading text in the libstdc++ manual that says the
> > > > > docs for the gcc-11 branch refer to mainline.
> > > > >
> > > > > Richi, is this OK for the gcc-11 branch now? It's been wrong for 11.1
> > > > > and 11.2, but it would still be nice to fix.
> > > >
> > > > Yes, it's OK.  I notice the same problem exists on the GCC 10 branch
> > > > but GCC 9 at least mentions GCC 9 once ;)
> > >
> > > Yes, I fixed it for gcc-9.3.0, but forgot to do it for gcc-10 and gcc-11.
> > >
> > > I pushed r10-10534 to fix gcc-10 (since that's open for doc changes)
> > > and have now pushed r11-9881
> > > as well.
> > >
> > > Maybe this year I'll remember to do it for gcc-12 after we branch from trunk!
> >
> > Add an entry to branching.html!
> 
> Like this? OK for wwwdocs?

Maybe

"Notify libstdc++ maintainers to update ..."

?

OK with that change.

Richard.
Jonathan Wakely April 19, 2022, 10:40 a.m. UTC | #6
On Tue, 19 Apr 2022 at 08:01, Richard Biener <rguenther@suse.de> wrote:
>
> On Thu, 14 Apr 2022, Jonathan Wakely wrote:
>
> > On Thu, 14 Apr 2022 at 11:55, Richard Biener <rguenther@suse.de> wrote:
> > >
> > > On Thu, 14 Apr 2022, Jonathan Wakely wrote:
> > >
> > > > On Thu, 14 Apr 2022 at 11:36, Richard Biener <rguenther@suse.de> wrote:
> > > > >
> > > > > On Thu, 14 Apr 2022, Jonathan Wakely wrote:
> > > > >
> > > > > > This fixes some misleading text in the libstdc++ manual that says the
> > > > > > docs for the gcc-11 branch refer to mainline.
> > > > > >
> > > > > > Richi, is this OK for the gcc-11 branch now? It's been wrong for 11.1
> > > > > > and 11.2, but it would still be nice to fix.
> > > > >
> > > > > Yes, it's OK.  I notice the same problem exists on the GCC 10 branch
> > > > > but GCC 9 at least mentions GCC 9 once ;)
> > > >
> > > > Yes, I fixed it for gcc-9.3.0, but forgot to do it for gcc-10 and gcc-11.
> > > >
> > > > I pushed r10-10534 to fix gcc-10 (since that's open for doc changes)
> > > > and have now pushed r11-9881
> > > > as well.
> > > >
> > > > Maybe this year I'll remember to do it for gcc-12 after we branch from trunk!
> > >
> > > Add an entry to branching.html!
> >
> > Like this? OK for wwwdocs?
>
> Maybe
>
> "Notify libstdc++ maintainers to update ..."
>
> ?
>
> OK with that change.

Yes, that's better. Pushed with that change, thanks.
diff mbox series

Patch

diff --git a/libstdc++-v3/doc/xml/manual/status_cxx1998.xml b/libstdc++-v3/doc/xml/manual/status_cxx1998.xml
index 792272bcf26..f1be6667cd7 100644
--- a/libstdc++-v3/doc/xml/manual/status_cxx1998.xml
+++ b/libstdc++-v3/doc/xml/manual/status_cxx1998.xml
@@ -18,8 +18,7 @@  This status table is based on the table of contents of ISO/IEC 14882:2003.
 </para>
 
 <para>
-This section describes the C++ support in mainline GCC, not in any
-particular release.
+This section describes the C++ support in the GCC 11 release series.
 </para>
 
 <!-- Status is Yes or No, Broken/Partial-->
diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2011.xml b/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
index 88844f8f0cc..e06f2479763 100644
--- a/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
+++ b/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
@@ -34,8 +34,7 @@  This status table is based on the table of contents of ISO/IEC 14882:2011.
 </para>
 
 <para>
-This section describes the C++11 support in mainline GCC, not in any
-particular release.
+This section describes the C++11 support in the GCC 11 release series.
 </para>
 
 <!-- Status is Yes or No, Broken/Partial-->
diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2014.xml b/libstdc++-v3/doc/xml/manual/status_cxx2014.xml
index 5dc287707d8..deb15c7f0d5 100644
--- a/libstdc++-v3/doc/xml/manual/status_cxx2014.xml
+++ b/libstdc++-v3/doc/xml/manual/status_cxx2014.xml
@@ -29,8 +29,8 @@  since C++11 and the implementation is complete.
 </para>
 
 <para>
-This section describes the C++14 and library TS support in mainline GCC,
-not in any particular release.
+This section describes the C++14 and library TS support in the GCC 11
+release series.
 </para>
 
 <!-- Status is Yes or No, Broken/Partial-->
diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2017.xml b/libstdc++-v3/doc/xml/manual/status_cxx2017.xml
index 11372bb28b3..52bbce0a2be 100644
--- a/libstdc++-v3/doc/xml/manual/status_cxx2017.xml
+++ b/libstdc++-v3/doc/xml/manual/status_cxx2017.xml
@@ -23,8 +23,8 @@  since that release.
 </para>
 
 <para>
-This section describes the C++17 and library TS support in mainline GCC,
-not in any particular release.
+This section describes the C++17 and library TS support in the GCC 11
+release series.
 </para>
 
 <para>
diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2020.xml b/libstdc++-v3/doc/xml/manual/status_cxx2020.xml
index 9e9777ea85f..411a337c534 100644
--- a/libstdc++-v3/doc/xml/manual/status_cxx2020.xml
+++ b/libstdc++-v3/doc/xml/manual/status_cxx2020.xml
@@ -20,8 +20,8 @@  presence of the required flag.
 </para>
 
 <para>
-This section describes the C++20 and library TS support in mainline GCC,
-not in any particular release.
+This section describes the C++20 and library TS support in the GCC 11
+release series.
 </para>
 
 <para>
diff --git a/libstdc++-v3/doc/xml/manual/status_cxxtr1.xml b/libstdc++-v3/doc/xml/manual/status_cxxtr1.xml
index 021cb6394a7..6533857ba12 100644
--- a/libstdc++-v3/doc/xml/manual/status_cxxtr1.xml
+++ b/libstdc++-v3/doc/xml/manual/status_cxxtr1.xml
@@ -22,8 +22,7 @@  In this implementation the header names are prefixed by
 </para>
 
 <para>
-This page describes the TR1 support in mainline GCC, not in any particular
-release.
+This page describes the TR1 support in the GCC 11 release series.
 </para>
 
 <!-- Status is Yes or No, Broken/Partial-->
diff --git a/libstdc++-v3/doc/xml/manual/status_cxxtr24733.xml b/libstdc++-v3/doc/xml/manual/status_cxxtr24733.xml
index 139b94442e8..4b6d64c7c6a 100644
--- a/libstdc++-v3/doc/xml/manual/status_cxxtr24733.xml
+++ b/libstdc++-v3/doc/xml/manual/status_cxxtr24733.xml
@@ -16,8 +16,7 @@  decimal floating-point arithmetic
 </para>
 
 <para>
-This page describes the TR 24733 support in mainline GCC, not in any
-particular release.
+This page describes the TR 24733 support in the GCC 11 release series.
 </para>
 
 <!-- Status is Yes or No, Broken/Partial-->