summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorReuben Thomas <rrt@sc3d.org>2020-10-15 13:11:11 +0100
committerKarl Berry <karl@freefriends.org>2020-10-23 18:14:10 -0700
commite30c0962414a56bd03c13db496f5f2e8735097cf (patch)
tree963dafb92667724344a6eae6a9898620bc6b3430
parentf832992db3490fecd8059b69ce302813bc539f52 (diff)
downloadautomake-e30c0962414a56bd03c13db496f5f2e8735097cf.tar.gz
contrib/README: fix and clarify the English
-rw-r--r--contrib/README35
1 files changed, 16 insertions, 19 deletions
diff --git a/contrib/README b/contrib/README
index a4d7eeb8d..f43e1da9b 100644
--- a/contrib/README
+++ b/contrib/README
@@ -1,26 +1,23 @@
This is the 'contrib' directory of the GNU Automake distribution.
-Here you'll find additions to the Automake base distribution, in form of
-makefile fragments, m4 macros, scripts, documentation, et cetera. Such
-addition that might be useful for a significant percentage of its general
-audience, but (for one reason or another) are not deemed appropriate for
-inclusion into the Automake core.
+Here you'll find additions to the Automake base distribution, in the form of
+makefile fragments, m4 macros, scripts, documentation, et cetera: additions
+that might be handy to many users, but (for one reason or another) are not
+deemed appropriate for inclusion into the Automake core.
-There are several reasons for which a feature can be kept in contrib:
+There are several reasons that a feature might be kept in contrib:
1. The long-term usefulness of the feature is debatable and uncertain;
- on-field and real-word testing are necessary to prove or disprove
- its usefulness, before the feature can be committed into the Automake
- core (as doing so too early would later force us to continue the
- support for backward-compatibility, even if the features proves
- flawed or fails to attract widespread use).
+ real-world testing is necessary to prove or disprove its usefulness,
+ before the feature can be committed into the Automake core (as doing so
+ too early would later force us to continue support for
+ backward-compatibility, even if the feature proved flawed or fails to
+ attract widespread use).
- 2. The APIs or overall design of the feature are still unstable, and
- need on-field testing to iron warts and usability bugs, or uncover
- potential flaws.
+ 2. The APIs or overall design of the feature are still unstable, and need
+ testing to iron out warts and usability bugs, or uncover potential flaws.
- 3. The feature was an historical one, mostly obsoleted but still used
- "here and there" in the wild; so we want to to deprecate it and
- remove it from the Automake core, but cannot remove it altogether,
- for the sake of those still-existing usage. So it gets moved in
- contrib.
+ 3. The feature was an historical one, mostly obsolete but still used in the
+ wild. We want to deprecate it and remove it from the Automake core, but
+ cannot remove it altogether, for the sake of the existing usage, so it
+ gets moved in contrib.