summaryrefslogtreecommitdiff
path: root/doc/obsolete.texi
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2017-05-10 19:19:51 +0200
committerBruno Haible <bruno@clisp.org>2017-05-10 19:19:51 +0200
commit67d14683778cb3fd8dbfda5a03f5fe407f57389a (patch)
tree19fc3d2bf61f2514a25a47aee028b0402986004b /doc/obsolete.texi
parent3f67783fb1ff94c6a3732cfbc4850048bcabc4ff (diff)
downloadgnulib-67d14683778cb3fd8dbfda5a03f5fe407f57389a.tar.gz
Prepare for reordering sections in the manual.
* doc/gnulib.texi: Move several sections to separate files. Include these files. * doc/out-of-memory.texi: New file, extracted from doc/gnulib.texi. * doc/obsolete.texi: Likewise. * doc/extra-tests.texi: Likewise. * doc/transversal.texi: Likewise. * doc/namespace.texi: Likewise. * doc/check-version.texi: Likewise. * doc/windows-sockets.texi: Likewise. * doc/windows-libtool.texi: Likewise. * doc/licenses-texi.texi: Likewise. * doc/build-automation.texi: Likewise. * doc/c-locale.texi: Likewise.
Diffstat (limited to 'doc/obsolete.texi')
-rw-r--r--doc/obsolete.texi23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/obsolete.texi b/doc/obsolete.texi
new file mode 100644
index 0000000000..90280ce392
--- /dev/null
+++ b/doc/obsolete.texi
@@ -0,0 +1,23 @@
+@node Obsolete modules
+@section Obsolete modules
+
+@cindex Obsolete modules
+Modules can be marked obsolete. This means that the problems they fix
+don't occur any more on the platforms that are reasonable porting targets
+now. @code{gnulib-tool} warns when obsolete modules are mentioned on the
+command line, and by default ignores dependencies from modules to obsolete
+modules. When you pass the option @code{--with-obsolete} to
+@code{gnulib-tool}, dependencies to obsolete modules will be included,
+however, unless blocked through an @code{--avoid} option. This option
+is useful if your package should be portable even to very old platforms.
+
+In order to mark a module obsolete, you need to add this to the module
+description:
+
+@example
+Status:
+obsolete
+
+Notice:
+This module is obsolete.
+@end example