summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Josefsson <simon@josefsson.org>2021-09-04 09:19:37 +0200
committerSimon Josefsson <simon@josefsson.org>2021-09-04 09:19:37 +0200
commit6b8032a320a75053c6607fcd37d2d67ffe61fd77 (patch)
tree0ecd45ce3b974f1451d57a51351e139a40f8a234
parent8f043c699535cdb0ffa0dee8d624ca38aada2deb (diff)
downloadgnulib-6b8032a320a75053c6607fcd37d2d67ffe61fd77.tar.gz
doc: Add suggestions on FDL texinfo usage.
* doc/licenses-texi.texi (License Texinfo sources): Add texinfo examples.
-rw-r--r--ChangeLog6
-rw-r--r--doc/licenses-texi.texi38
2 files changed, 38 insertions, 6 deletions
diff --git a/ChangeLog b/ChangeLog
index 51d1f3d37a..e762c210d7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2021-09-04 Simon Josefsson <simon@josefsson.org>
+
+ doc: Add suggestions on FDL texinfo usage.
+ * doc/licenses-texi.texi (License Texinfo sources): Add texinfo
+ examples.
+
2021-09-03 Simon Josefsson <simon@josefsson.org>
maintainer-makefile: Add indentation syntax-check rule.
diff --git a/doc/licenses-texi.texi b/doc/licenses-texi.texi
index 630272c98f..aebeb462db 100644
--- a/doc/licenses-texi.texi
+++ b/doc/licenses-texi.texi
@@ -8,8 +8,8 @@ have any node names and structures built into them; for your manual,
you should @code{@@include} them in an appropriate @code{@@node}.
The conventional name for the GPL node is @samp{Copying} and for the FDL
-@samp{GNU Free Documentation License}. The LGPL doesn't seem to have
-a conventional node name.
+@samp{GNU Free Documentation License}. The LGPL doesn't seem to have a
+conventional node name.
Of course the license texts themselves should not be changed at all.
@@ -37,8 +37,34 @@ you use the GNU FDL, you need to specify the Invariant Sections, the
Front-Cover Texts, and the Back-Cover Texts.
To make use of this documentation license, copy the relevant Texinfo
-file into your VCS repository. This makes sure that anyone who receives
-a copy of your VCS repository has also received a copy of the
-documentation license. In the documentation, also state what are the
-Invariant Sections, the Front-Cover Texts, and the Back-Cover Texts.
+file (@code{doc/fdl-1.3.texi}) into your VCS repository. This makes
+sure that anyone who receives a copy of your VCS repository has also
+received a copy of the documentation license. In the documentation,
+also state what are the Invariant Sections, the Front-Cover Texts, and
+the Back-Cover Texts.
@end itemize
+
+We recommend to place the licenses as appendices at the end of the
+manual, right before any indices. For the FDL, we suggest the following
+@code{@@menu} entry:
+
+@smallexample
+* GNU Free Documentation License:: License for copying this manual
+@end smallexample
+
+For any @code{@@detailmenu} entries, we suggest the following:
+
+@smallexample
+Copying This Manual
+
+* GNU Free Documentation License:: Copying and sharing this manual
+@end smallexample
+
+And for actual inclusion of the FDL itself, we suggest the following:
+
+@smallexample
+@@node GNU Free Documentation License
+@@appendix GNU Free Documentation License
+
+@@include fdl.texi
+@end smallexample