manual: Show copyright information not just in the printed manual
Commit Message
@insertcopying was not used at all in the Info and HTML versions.
As a result, the notices that need to be present according to the
GNU Free Documentation License were missing.
This commit shows these notices above the table of contents in the
HTML version, and as part of the Main Menu node in the Info version.
Remove the "This file documents" line because it is redudant with the
following line.
---
manual/libc.texinfo | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
Comments
* Florian Weimer via Libc-alpha:
> @insertcopying was not used at all in the Info and HTML versions.
> As a result, the notices that need to be present according to the
> GNU Free Documentation License were missing.
>
> This commit shows these notices above the table of contents in the
> HTML version, and as part of the Main Menu node in the Info version.
>
> Remove the "This file documents" line because it is redudant with the
> following line.
Ping. This patch needs review:
<https://sourceware.org/pipermail/libc-alpha/2020-May/114314.html>
Thanks,
Florian
On 5/25/20 8:10 AM, Florian Weimer via Libc-alpha wrote:
> @insertcopying was not used at all in the Info and HTML versions.
> As a result, the notices that need to be present according to the
> GNU Free Documentation License were missing.
>
> This commit shows these notices above the table of contents in the
> HTML version, and as part of the Main Menu node in the Info version.
>
> Remove the "This file documents" line because it is redudant with the
s/redudant/redundant/g
> following line.
OK for master. Reviewed pdf and html and they look good to me.
Tested-by: Carlos O'Donell <carlos@redhat.com>
Reviewed-by: Carlos O'Donell <carlos@redhat.com>
>
> ---
> manual/libc.texinfo | 20 +++++++++++---------
> 1 file changed, 11 insertions(+), 9 deletions(-)
>
> diff --git a/manual/libc.texinfo b/manual/libc.texinfo
> index 692a8f20b2..9c8df2cba7 100644
> --- a/manual/libc.texinfo
> +++ b/manual/libc.texinfo
> @@ -40,8 +40,6 @@
> @set FDL_VERSION 1.3
>
> @copying
> -This file documents @theglibc{}.
> -
OK.
> This is
> @c Disabled (printed editions, see above).
> @c Edition @value{EDITION} of
> @@ -105,20 +103,24 @@ supports it in developing GNU and promoting software freedom.''
>
> @end titlepage
>
> +@c @titlepage is only visible in the printed manual. Show the
> +@c copyright information elsewhere in other renderings. For the HTML
> +@c version, it should come above the short table of contents. In the
> +@c Info manual, the option below is used.
> +@ifhtml
> +@insertcopying
> +@end ifhtml
OK.
> +
> @shortcontents
> @contents
>
> @ifnottex
> @node Top, Introduction, (dir), (dir)
> @top Main Menu
> -This is
> @c Disabled (printed editions, see above).
> -@c Edition @value{EDITION} of
> -@cite{The GNU C Library Reference Manual}, for Version @value{VERSION}
> -@ifclear PKGVERSION_DEFAULT
> -@value{PKGVERSION}
> -@end ifclear
> -of @theglibc{}.
> +@ifnothtml
> +@insertcopying
> +@end ifnothtml
OK.
> @end ifnottex
>
> @include top-menu.texi
>
@@ -40,8 +40,6 @@
@set FDL_VERSION 1.3
@copying
-This file documents @theglibc{}.
-
This is
@c Disabled (printed editions, see above).
@c Edition @value{EDITION} of
@@ -105,20 +103,24 @@ supports it in developing GNU and promoting software freedom.''
@end titlepage
+@c @titlepage is only visible in the printed manual. Show the
+@c copyright information elsewhere in other renderings. For the HTML
+@c version, it should come above the short table of contents. In the
+@c Info manual, the option below is used.
+@ifhtml
+@insertcopying
+@end ifhtml
+
@shortcontents
@contents
@ifnottex
@node Top, Introduction, (dir), (dir)
@top Main Menu
-This is
@c Disabled (printed editions, see above).
-@c Edition @value{EDITION} of
-@cite{The GNU C Library Reference Manual}, for Version @value{VERSION}
-@ifclear PKGVERSION_DEFAULT
-@value{PKGVERSION}
-@end ifclear
-of @theglibc{}.
+@ifnothtml
+@insertcopying
+@end ifnothtml
@end ifnottex
@include top-menu.texi