contrib/README

   1 This is the 'contrib' directory of the GNU Automake distribution.
   2
   3 Here you'll find additions to the Automake base distribution, in form of
   4 makefile fragments, m4 macros, scripts, documentation, et cetera.  Such
   5 addition that might be useful for a significant percentage of its general
   6 audience, but (for one reason or another) are not deemed appropriate for
   7 inclusion into the Automake core.
   8
   9 There are several reasons for which a feature can be kept in contrib:
  10
  11   1. The long-term usefulness of the feature is debatable and uncertain;
  12      on-field and real-word testing are necessary to prove or disprove
  13      its usefulness, before the feature can be committed into the Automake
  14      core (as doing so too early would later force us to continue the
  15      support for backward-compatibility, even if the features proves
  16      flawed or fails to attract widespread use).
  17
  18   2. The APIs or overall design of the feature are still unstable, and
  19      need on-field testing to iron warts and usability bugs, or uncover
  20      potential flaws.
  21
  22   3. The feature was an historical one, mostly obsoleted but still used
  23      "here and there" in the wild; so we want to to deprecate it and
  24      remove it from the Automake core, but cannot remove it altogether,
  25      for the sake of those still-existing usage.  So it gets moved in
  26      contrib.