summaryrefslogtreecommitdiff
path: root/doc/obsolete.texi
blob: 90280ce392ea80cf4c7435af54d1b8341dd2a645 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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