* [PATCH] update copyright year in libstdc++ manual
@ 2023-03-10 23:08 Jonny Grant
2023-03-12 18:46 ` Sandra Loosemore
2023-03-13 10:43 ` [PATCH] update copyright year in libstdc++ manual Jonathan Wakely
0 siblings, 2 replies; 5+ messages in thread
From: Jonny Grant @ 2023-03-10 23:08 UTC (permalink / raw)
To: libstdc++, gcc-patches
docs: update copyright year in libstdc++ manual
gcc/ChangeLog
* libstdc++-v3/doc/xml/faq.xml: update copyright year in libstdc++ manual
---
libstdc++-v3/doc/xml/faq.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/libstdc++-v3/doc/xml/faq.xml b/libstdc++-v3/doc/xml/faq.xml
index 9ae4966ecea..42354f87af7 100644
--- a/libstdc++-v3/doc/xml/faq.xml
+++ b/libstdc++-v3/doc/xml/faq.xml
@@ -7,7 +7,7 @@
<copyright>
<year>
- 2008-2018
+ 2008-2023
</year>
<holder>
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.fsf.org">FSF</link>
-- 2.37.2
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] update copyright year in libstdc++ manual
2023-03-10 23:08 [PATCH] update copyright year in libstdc++ manual Jonny Grant
@ 2023-03-12 18:46 ` Sandra Loosemore
2023-03-12 20:48 ` Jonathan Wakely
2023-03-13 10:43 ` [PATCH] update copyright year in libstdc++ manual Jonathan Wakely
1 sibling, 1 reply; 5+ messages in thread
From: Sandra Loosemore @ 2023-03-12 18:46 UTC (permalink / raw)
To: Jonny Grant, libstdc++, gcc-patches
On 3/10/23 16:08, Jonny Grant wrote:
> docs: update copyright year in libstdc++ manual
>
> gcc/ChangeLog
> * libstdc++-v3/doc/xml/faq.xml: update copyright year in libstdc++ manual
This change looks trivial enough, but IIUC the corresponding HTML file
also needs to be regenerated when checking in this change, and I confess
I do not know the recipe for doing that. :-( Maybe we should put that
information, or a pointer to it, in a README file somewhere? I also
understand that some libstdc++ manual pieces are generated by Doxygen
and have no idea how that works either, or what tools one must have
installed to make any of this work.
-Sandra
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] update copyright year in libstdc++ manual
2023-03-12 18:46 ` Sandra Loosemore
@ 2023-03-12 20:48 ` Jonathan Wakely
2023-03-13 10:46 ` [committed] libstdc++: Refer to documentation hacking docs from Makefile Jonathan Wakely
0 siblings, 1 reply; 5+ messages in thread
From: Jonathan Wakely @ 2023-03-12 20:48 UTC (permalink / raw)
To: Sandra Loosemore; +Cc: Jonny Grant, libstdc++, gcc-patches
On Sun, 12 Mar 2023 at 18:46, Sandra Loosemore wrote:
>
> On 3/10/23 16:08, Jonny Grant wrote:
> > docs: update copyright year in libstdc++ manual
> >
> > gcc/ChangeLog
> > * libstdc++-v3/doc/xml/faq.xml: update copyright year in libstdc++ manual
>
> This change looks trivial enough, but IIUC the corresponding HTML file
> also needs to be regenerated when checking in this change, and I confess
> I do not know the recipe for doing that. :-( Maybe we should put that
> information, or a pointer to it, in a README file somewhere? I also
> understand that some libstdc++ manual pieces are generated by Doxygen
> and have no idea how that works either, or what tools one must have
> installed to make any of this work.
It's all thoroughly documented:
https://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_hacking.html#doc.generation
I was going to take care of the patch on Monday.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] update copyright year in libstdc++ manual
2023-03-10 23:08 [PATCH] update copyright year in libstdc++ manual Jonny Grant
2023-03-12 18:46 ` Sandra Loosemore
@ 2023-03-13 10:43 ` Jonathan Wakely
1 sibling, 0 replies; 5+ messages in thread
From: Jonathan Wakely @ 2023-03-13 10:43 UTC (permalink / raw)
To: Jonny Grant; +Cc: libstdc++, gcc-patches
On Fri, 10 Mar 2023 at 23:09, Jonny Grant wrote:
>
> docs: update copyright year in libstdc++ manual
Thanks for the patch.
> gcc/ChangeLog
> * libstdc++-v3/doc/xml/faq.xml: update copyright year in libstdc++ manual
This should be in the libstdc++-v3/ChangeLog file, not gcc/ChangeLog,
and the description should be a complete sentence with capital letter
and full stop.
I corrected the commit message and pushed it as
r13-6626-gdbec2e816922ba then regenerated the docs.
>
> ---
> libstdc++-v3/doc/xml/faq.xml | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/libstdc++-v3/doc/xml/faq.xml b/libstdc++-v3/doc/xml/faq.xml
> index 9ae4966ecea..42354f87af7 100644
> --- a/libstdc++-v3/doc/xml/faq.xml
> +++ b/libstdc++-v3/doc/xml/faq.xml
> @@ -7,7 +7,7 @@
>
> <copyright>
> <year>
> - 2008-2018
> + 2008-2023
> </year>
> <holder>
> <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://www.fsf.org">FSF</link>
> -- 2.37.2
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* [committed] libstdc++: Refer to documentation hacking docs from Makefile
2023-03-12 20:48 ` Jonathan Wakely
@ 2023-03-13 10:46 ` Jonathan Wakely
0 siblings, 0 replies; 5+ messages in thread
From: Jonathan Wakely @ 2023-03-13 10:46 UTC (permalink / raw)
To: libstdc++, gcc-patches; +Cc: Sandra Loosemore, Jonny Grant
I've pushed this to trunk, so that it's easier to find the docs on
maintaining the docs.
-- >8 --
pick fdcba7a9088 libstdc++: Update copyright year in FAQ
pick 6d8325681ef libstdc++: Regenerate HTML docs
libstdc++-v3/ChangeLog:
* doc/Makefile.am: Add comment referring to documentation.
* doc/Makefile.in: Regenerate.
---
libstdc++-v3/doc/Makefile.am | 2 ++
libstdc++-v3/doc/Makefile.in | 2 ++
2 files changed, 4 insertions(+)
diff --git a/libstdc++-v3/doc/Makefile.am b/libstdc++-v3/doc/Makefile.am
index cc18b61cf55..8371441c62e 100644
--- a/libstdc++-v3/doc/Makefile.am
+++ b/libstdc++-v3/doc/Makefile.am
@@ -24,6 +24,8 @@ include $(top_srcdir)/fragment.am
# Documentation Overview
#
+# See ./xml/manual/documentation_hacking.xml for full details.
+#
# There are two main input materials for libstdc++ documentation.
# The first is the doxygen markup in libstdc++ sources, which is a
# reference to the API. And the second is the manual, via docbook markup in
diff --git a/libstdc++-v3/doc/Makefile.in b/libstdc++-v3/doc/Makefile.in
index db5e81a7d60..21ad8557f7a 100644
--- a/libstdc++-v3/doc/Makefile.in
+++ b/libstdc++-v3/doc/Makefile.in
@@ -393,6 +393,8 @@ AM_CPPFLAGS = $(GLIBCXX_INCLUDES) $(CPPFLAGS)
# Documentation Overview
#
+# See ./xml/manual/documentation_hacking.xml for full details.
+#
# There are two main input materials for libstdc++ documentation.
# The first is the doxygen markup in libstdc++ sources, which is a
# reference to the API. And the second is the manual, via docbook markup in
--
2.39.2
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2023-03-13 10:46 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-03-10 23:08 [PATCH] update copyright year in libstdc++ manual Jonny Grant
2023-03-12 18:46 ` Sandra Loosemore
2023-03-12 20:48 ` Jonathan Wakely
2023-03-13 10:46 ` [committed] libstdc++: Refer to documentation hacking docs from Makefile Jonathan Wakely
2023-03-13 10:43 ` [PATCH] update copyright year in libstdc++ manual Jonathan Wakely
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).