From ebd7fb6329bb46fca77f9bcaaf6f6c085f749b95 Mon Sep 17 00:00:00 2001 From: Alexandre Duret-Lutz Date: Tue, 19 Feb 2002 21:04:56 +0000 Subject: [PATCH] * automake.texi (Macros): Split into ... (Public Macros, Private Macros): ... these. --- ChangeLog | 5 ++++ automake.texi | 78 +++++++++++++++++++++++++++++++++------------------ stamp-vti | 2 +- version.texi | 2 +- 4 files changed, 57 insertions(+), 30 deletions(-) diff --git a/ChangeLog b/ChangeLog index 7688b8cf..8c84bd53 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2002-02-19 Alexandre Duret-Lutz + + * automake.texi (Macros): Split into ... + (Public Macros, Private Macros): ... these. + 2002-02-19 Alexandre Duret-Lutz * tests/insthook.test: Use sed instead of "tail +X". diff --git a/automake.texi b/automake.texi index 1bcb825e..447b95a5 100644 --- a/automake.texi +++ b/automake.texi @@ -1351,7 +1351,19 @@ Print the version number of Automake and exit. @node Macros, Extending aclocal, Invoking aclocal, configure @section Autoconf macros supplied with Automake -@c consider generating this node automatically from m4 files. +Automake ships with several Autoconf macros that you can use from your +@file{configure.in}. When you use one of them it will be included by +@code{aclocal} in @file{aclocal.m4}. + +@menu +* Public macros:: Macros that you can use. +* Private macros:: Macros that you should not use. +@end menu + +@c consider generating the following subsections automatically from m4 files. + +@node Public macros, Private macros, Macros, Macros +@subsection Public macros @table @code @item AM_CONFIG_HEADER @@ -1367,15 +1379,6 @@ the top source directory; it defaults to the empty string (generally this should not be used unless you are familiar with the internals). @xref{Multilibs}. -@item _AM_DEPENDENCIES -@itemx AM_SET_DEPDIR -@itemx AM_DEP_TRACK -@itemx AM_OUTPUT_DEPENDENCY_COMMANDS -@c FIXME: Consider not documenting these internal macros. -These macros are used to implement automake's automatic dependency -tracking scheme. They are called automatically by automake when -required, and there should be no need to invoke them manually. - @item AM_C_PROTOTYPES Check to see if function prototypes are understood by the compiler. If so, define @samp{PROTOTYPES} and set the output variables @samp{U} and @@ -1441,12 +1444,6 @@ or by passing a third non-empty argument to the obsolete form. @cvindex VERSION, prevent definition -@item AM_MAKE_INCLUDE -@c FIXME: Consider not documenting this internal macro. -This macro is used to discover how the user's @code{make} handles -@code{include} statements. This macro is automatically invoked when -needed; there should be no need to invoke it manually. - @item AM_PATH_LISPDIR Searches for the program @code{emacs}, and, if found, sets the output variable @code{lispdir} to the full path to Emacs' site-lisp directory. @@ -1488,18 +1485,6 @@ This macro finds the @code{gcj} program or causes an error. It sets GNU Compiler Collection. @cvindex AM_PROG_GCJ -@item AM_PROG_INSTALL_STRIP -This is used to find a version of @code{install} which can be used to -@code{strip} a program at installation time. This macro is -automatically included when required. - -@item AM_SANITY_CHECK -@c FIXME: Consider not documenting this internal macro. -This checks to make sure that a file created in the build directory is -newer than a file in the source directory. This can fail on systems -where the clock is set incorrectly. This macro is automatically run -from @code{AM_INIT_AUTOMAKE}. - @item AM_SYS_POSIX_TERMIOS @cvindex am_cv_sys_posix_termios @cindex POSIX termios headers @@ -1531,6 +1516,43 @@ into @samp{LIBOBJS}. @end table +@node Private macros, , Public macros, Macros +@subsection Private macros + +The following macros are private macros you should not call directly. +They are called by the other public macros when appropriate. Do not +rely on them, as they might be changed in a future version. Consider +them as implementation details; or better, do not consider them at all: +skip this section! + +@table @code +@item _AM_DEPENDENCIES +@itemx AM_SET_DEPDIR +@itemx AM_DEP_TRACK +@itemx AM_OUTPUT_DEPENDENCY_COMMANDS +These macros are used to implement automake's automatic dependency +tracking scheme. They are called automatically by automake when +required, and there should be no need to invoke them manually. + +@item AM_MAKE_INCLUDE +This macro is used to discover how the user's @code{make} handles +@code{include} statements. This macro is automatically invoked when +needed; there should be no need to invoke it manually. + +@item AM_PROG_INSTALL_STRIP +This is used to find a version of @code{install} which can be used to +@code{strip} a program at installation time. This macro is +automatically included when required. + +@item AM_SANITY_CHECK +This checks to make sure that a file created in the build directory is +newer than a file in the source directory. This can fail on systems +where the clock is set incorrectly. This macro is automatically run +from @code{AM_INIT_AUTOMAKE}. + +@end table + + @node Extending aclocal, , Macros, configure @section Writing your own aclocal macros diff --git a/stamp-vti b/stamp-vti index 419d7c89..54797834 100644 --- a/stamp-vti +++ b/stamp-vti @@ -1,4 +1,4 @@ -@set UPDATED 17 February 2002 +@set UPDATED 19 February 2002 @set UPDATED-MONTH February 2002 @set EDITION 1.5e @set VERSION 1.5e diff --git a/version.texi b/version.texi index 419d7c89..54797834 100644 --- a/version.texi +++ b/version.texi @@ -1,4 +1,4 @@ -@set UPDATED 17 February 2002 +@set UPDATED 19 February 2002 @set UPDATED-MONTH February 2002 @set EDITION 1.5e @set VERSION 1.5e -- 2.43.5