[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[FYI] {maint} docs: minor cosmetic fixes
From: |
Stefano Lattarini |
Subject: |
[FYI] {maint} docs: minor cosmetic fixes |
Date: |
Thu, 23 Jun 2011 18:40:25 +0200 |
User-agent: |
KMail/1.13.3 (Linux/2.6.30-2-686; KDE/4.4.4; i686; ; ) |
* doc/automake.texi: Break few overly long lines, throughout the
file.
("Simple Tests"): Move @vindex for XFAIL_TESTS to the correct
position, i.e., before and not after the paragraph where it is
introduced.
("Options" @item ansi2knr): Don't user @xref where @pxref should
be used instead. This fixes a texinfo warning.
("Other things Automake recognizes" @item AM_C_PROTOTYPES): Don't
@ref where @pxref should be used instead.
---
ChangeLog | 13 +++++++++++++
doc/automake.texi | 28 ++++++++++++++++------------
2 files changed, 29 insertions(+), 12 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 26093d3..6539f89 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,18 @@
2011-06-23 Stefano Lattarini <address@hidden>
+ docs: minor cosmetic fixes
+ * doc/automake.texi: Break few overly long lines, throughout the
+ file.
+ ("Simple Tests"): Move @vindex for XFAIL_TESTS to the correct
+ position, i.e., before and not after the paragraph where it is
+ introduced.
+ ("Options" @item ansi2knr): Don't user @xref where @pxref should
+ be used instead. This fixes a texinfo warning.
+ ("Other things Automake recognizes" @item AM_C_PROTOTYPES): Don't
+ @ref where @pxref should be used instead.
+
+2011-06-23 Stefano Lattarini <address@hidden>
+
help: improve text about automatically-distributed files
This change fixes automake bug#7819.
* automake.in (usage): Distinguish between files that are always
diff --git a/doc/automake.texi b/doc/automake.texi
index 14cf7e6..cf46c29 100644
--- a/doc/automake.texi
+++ b/doc/automake.texi
@@ -84,7 +84,8 @@ section entitled ``GNU Free Documentation License.''
@c Put the macros in the function index.
@syncodeindex ac fn
address@hidden Put everything else into one index (arbitrarily chosen to be the
concept index).
address@hidden Put everything else into one index (arbitrarily chosen to be the
address@hidden concept index).
@syncodeindex op cp
@syncodeindex tr cp
@syncodeindex cm cp
@@ -3021,8 +3022,9 @@ this way, e.g., @code{AC_PATH_XTRA} defines
@code{X_CFLAGS} and
if @code{AC_PATH_XTRA} is called.
@item AM_C_PROTOTYPES
-This is required when using the deprecated de-ANSI-fication feature; see
address@hidden @emph{It will be removed} in the next major Automake release.
+This is required when using the deprecated de-ANSI-fication feature;
address@hidden @emph{It will be removed} in the next major Automake
+release.
@item AM_CONDITIONAL
This introduces an Automake conditional (@pxref{Conditionals}).
@@ -5828,7 +5830,8 @@ needs to be avoided: when a target should not be built
from sources.
We already saw such an example in @ref{true}; this happens when all
the constituents of a target have already been compiled and just need
to be combined using a @code{_LDADD} variable. Then it is necessary
-to define an empty @code{_SOURCES} variable, so that @command{automake} does
not
+to define an empty @code{_SOURCES} variable, so that @command{automake}
+does not compute a default.
@example
@@ -6811,8 +6814,9 @@ If no directory prefix is given, the files are assumed to
be in the
current directory.
Note that automatic de-ANSI-fication will not work when the package is
-being built for a different host architecture. That is because
@command{automake}
-currently has no way to build @command{ansi2knr} for the build machine.
+being built for a different host architecture. That is because
address@hidden currently has no way to build @command{ansi2knr}
+for the build machine.
@c FIXME: this paragraph might be better moved to an `upgrading' section.
@cindex @code{LTLIBOBJS} and @code{ansi2knr}
@@ -6906,10 +6910,10 @@ bin_PROGRAMS = liver$(EXEEXT)
The targets Automake generates are likewise given the @samp{$(EXEEXT)}
extension.
-The variables @code{TESTS} and @code{XFAIL_TESTS} (@pxref{Simple Tests}) are
also
-rewritten if they contain filenames that have been declared as programs
-in the same @file{Makefile}. (This is mostly useful when some programs
-from @code{check_PROGRAMS} are listed in @code{TESTS}.)
+The variables @code{TESTS} and @code{XFAIL_TESTS} (@pxref{Simple Tests})
+are also rewritten if they contain filenames that have been declared as
+programs in the same @file{Makefile}. (This is mostly useful when some
+programs from @code{check_PROGRAMS} are listed in @code{TESTS}.)
However, Automake cannot apply this rewriting to @command{configure}
substitutions. This means that if you are conditionally building a
@@ -8644,10 +8648,10 @@ parallel-tests}).
@cindex Tests, expected failure
@cindex Expected test failure
address@hidden XFAIL_TESTS
You may define the variable @code{XFAIL_TESTS} to a list of tests
(usually a subset of @code{TESTS}) that are expected to fail. This will
reverse the result of those tests.
address@hidden XFAIL_TESTS
Automake ensures that each file listed in @code{TESTS} is built before
any tests are run; you can list both source and derived programs (or
@@ -9071,7 +9075,7 @@ implies options @option{readme-alpha} and
@option{check-news}.
@itemx @address@hidden/ansi2knr}
@cindex Option, @option{ansi2knr}
@opindex ansi2knr
-Turn on the deprecated de-ANSI-fication feature (@xref{ANSI}). Note
+Turn on the deprecated de-ANSI-fication feature (@pxref{ANSI}). Note
that that feature and this option @emph{will be removed} in the next
major Automake release.
--
1.7.2.3
- [FYI] {maint} docs: minor cosmetic fixes,
Stefano Lattarini <=