TODO

   1 Priorities for release:
   2 * Add Dieter's idea of dist-local target; document
   3
   4 Other priorities:
   5 * Must rewrite am_install_var.  Should break into multiple functions.
   6   This will allow the callers to be a little smarter.
   7 * Rewrite clean targets.
   8 * Must rewrite error handling code.  Right now it is a real mess
   9
  10 Currently gettext requires @INTLSUB@ and @POSUB@ in SUBDIRS.  In the
  11 future this will be just intl and po.  When that happens, re-enable
  12 warnings in handle_subdirs.
  13
  14 Consider supporting guile-style PLUGIN directories automatically?
  15
  16 Consider allowing eg "foo/bar" to appear in EXTRA_DIST, and generating
  17 code to make directory foo at dist time
  18
  19 Consider putting ansi2knr in AC_CONFIG_AUX_DIR
  20
  21 Check to make sure various scripts are executable (IE when looking for
  22 them in a directory)
  23
  24 Testing: allow support for Cygnus-style dejagnu-based test suites via
  25 an option
  26
  27 Think about ways to make automake fit better with Cygnus-style trees.
  28
  29 Omit program transform vars from header if no program installed.  This
  30 is currently pretty hard to do.
  31
  32 Use recode in dist target when MAINT_CHARSET specified.  Read caveats
  33 in automake.in before doing this.  Note the same problem used to apply
  34 to the no-dependencies option; maybe it still should?  Note also that
  35 each Makefile.am must be rewritten at "make dist" time if
  36 MAINT_CHARSET and DIST_CHARSET are not identical.  NOTE: gettext must
  37 arrange for all .po files not to be recoded.  In the long term this
  38 might be a problem (consider when some systems use Unicode but the
  39 rest do not)
  40
  41 Handle dist-zoo and dist-zip.  Generally add more DOS support.  Maybe
  42 run "doschk" (why isn't this merged with "pathchk"?) when doing a
  43 dist.  Do whatever else François says here...
  44
  45 Add support for html via an option.  Use texi2html.  Use
  46 "html_TEXINFOS", and htmldir = .../html.  Include html files in
  47 distribution.  Also allow "html_DATA", for raw .html files.
  48   [ when will texinfo support html? ]
  49
  50 uninstall and pkg-dirs should rm -rf the dir.
  51
  52 a potential bug: configure puts "blah.o" into LIBOBJS, thus implying
  53 these files can't be de-ansified.  Not a problem?
  54
  55 In general most .am files should be merged into automake.  For
  56 instance all the "clean" targets could be merged by keeping lists of
  57 things to be removed.  This would be a lot nicer looking.  Note that
  58 the install targets probably should not be merged; it is sometimes
  59 useful to only install a small part.
  60
  61 Clean up the output:
  62 * Order rules sensibly
  63 * Ensure every line has a purpose.  Omit unused stuff
  64 * Eliminate extraneous rules when possible (eg 'install-am' stuff)
  65 * Make sure vertical spacing is correct
  66 * pretty-print targets
  67 * regularize how backslash-newline is done.  Just one space between text
  68   and backslash should be the rule.  Update makefile-mode to allow this.
  69   (set column to 0, probably)
  70
  71 It should be possible to have ansi2knr in just one place in a package.
  72 Jim Meyering says just rely on configure to make links as appropriate.
  73 Maybe introduce syntax like this:
  74         AUTOMAKE_OPTIONS = ../ansi2knr
  75 ?
  76
  77 Lex, yacc support:
  78 * It would be nice to automatically support using bison's better features
  79   to rename the output files.  This requires autoconf support
  80 * Consider supporting syntax from autoconf "derived:source", eg:
  81         y.tab.c:perly.y
  82   for yacc and lex source
  83 * if AC_PROG_LEX used, ensure LEXLIB is in foo_LDADD
  84 * require AC_DECL_YYTEXT for lex
  85
  86 require AC_PROG_CXX if any C++ source files found?
  87 Better support for C++ all around
  88
  89 Write autoconf macro to do all work necessary for automake.  Eg define
  90 PACKAGE, VERSION, etc.
  91
  92 'maintainer-clean' should "rm -rf .deps".  Ditto distclean
  93 Should look for clean-local targets in Makefile.am.
  94
  95 It might be cool to generate .texi dependencies by grepping for
  96 @include.  (If done, it should be done the same way C dependencies are
  97 done)
  98
  99 It would be good to check some parts of GNU standards.  Already check
 100 for install-sh and mkinstalldirs.  What else is required to be in
 101 package by GNU standards or by automake?
 102 Some things for --strictness=gnits:
 103 * "cd $(foo); something" is an error in a rule.  Should be:
 104   "cd $(foo) && something"
 105 * Look for 'ln -s' and warn about using $(LN) and AC_PROG_LN_S
 106 * Look for $(LN) and require AC_PROG_LN_S
 107
 108 automake.in: should ".cc" really -> "$o"?  This doesn't really seem
 109 right, but maybe it is so names can be rewritten uniformly?  Must
 110 check
 111
 112 Auto-distribute "ChangeLog.[0-9]+"?  "ChangeLog.[a-z]+"?
 113
 114 Internationalize. [ gettext doesn't have the necessary machinery yet ]
 115 am_error should use printf-style arguments (for eventual gettext scheme)
 116
 117 François says the ordering of files in a distribution should be as follows:
 118 * README
 119 * source files
 120 * derived files
 121 I agree, but I don't see how to implement this yet.
 122 It might be easier if "derived files" is limited to those that
 123 Automake itself knows about, eg output of yacc.
 124
 125 Check all source files to make sure that FSF address is up-to-date.
 126 --gnits or --gnu only.
 127
 128 Merge each -vars.am file with corresponding ".am" file.  Can do this
 129 because of changes to &file_contents.
 130
 131 Looked at a program called 'ezmake', which seems to do something
 132 similar.  The only idea there that is possibly worth stealing is using
 133 globs in definitions.  Also has negations.  Eg in a directory with
 134 files a.c, b.c and c.c, the line:
 135         foo_SOURCES = *.c ~c.c
 136 would be equivalent to:
 137         foo_SOURCES = a.c b.c
 138 Is this worth implementing?
 139
 140 Should libexec programs have the name transform done on them?
 141
 142 Order the output rules sensibly, so FOO_SOURCES and FOO_OBJECTS are
 143 together and rules are in the usual order.
 144
 145 Make the output minimal: only output definitions for variables that
 146 are used.
 147
 148 Look at dist's jmake for ideas.  dist is the name of the distribution
 149 including Metaconfig.  Perl uses it.
 150
 151 Should handle directory hierarchies deeper than 2.  Right now there is
 152 some support for this.  Here are some of the issues:
 153 * Should handle AC_CONFIG_SUBDIRS, ie must handle configure.in in subdirs
 154 * Must handle SUBDIRS in subdir Makefile.am's
 155
 156 ================================================================
 157
 158 Document:
 159
 160
 161 Defined variables, their meanings, and their effects:
 162
 163 DEFS           cpp definitions
 164 INCLUDES       -I options to cpp
 165 CPPFLAGS       more cpp flags
 166 CFLAGS         flags to cc
 167 COMPILE        how to compile a C program
 168 LINK           how to link a C program
 169
 170 DIST_SUBDIRS   directories which are copied verbatim into the
 171                distribution.  Used eg for directories holding
 172                only example code (which don't have their own
 173                makefile).  This variable might be a bad idea.
 174   [ should just require a new Makefile.am.  They are supposed to be
 175     easy to write ]
 176
 177 Document customary ordering of Makefile.am.  From François.
 178
 179 must document that @ALLOCA@ works in _LDADD
 180
 181 Must document BUILT_SOURCES variable.  See depend.am.
 182
 183 Should include extended version of diagram from Autoconf (suggested by
 184 Greg Woods)
 185
 186 Must document macros which can be used when writing one's own rules.
 187 Must document INCLUDES
 188
 189 Document gettext support
 190
 191 Make a definition of the term "source"
 192
 193 ================================================================
 194
 195 Libraries:
 196
 197 * Should support standalone library along with subdir library in same
 198   Makefile.am.  Maybe: turn off "standalone" mode if library's Makefile.am
 199   is not only one specd? [ add an option for this ]
 200 * Need a way to handle shared libraries.
 201   It would be really interesting to be able to easily (as the end-user)
 202   make many different versions of the library: shared, static, profiling,
 203   debug, optimized...
 204   How does Perl handle this?  How does glibc handle this?
 205   This needs autoconf support
 206
 207 Some examples to keep in mind while doing this:
 208 * readline
 209 * kpathsea
 210
 211 Gord Matzigkeit is doing work on this issue, mostly from the Autoconf
 212 side of things.
 213
 214 ================================================================
 215
 216 Have a program that generates a Makefile on stdout, passes it through
 217 a "config.status"-style filter, and thence into make.  Why bother,
 218 other than the gee-whiz factor?
 219
 220 Would it be useful to integrate in some way with the Debian package
 221 building utility?  Must check.  maybe it would be possible to deal
 222 with all the different package utilities somehow.  Lately I've been
 223 hearing good things about the RedHat packaging utilities.  Why are
 224 there so many of these?  Are they fun to write or something?
 225 The RedHat package utility is called RPM; see
 226         ftp://ftp.redhat.com/pub/code/rpm
 227 It actually has problems, like no configure script and no documentation.
 228
 229 ================================================================
 230
 231 A tool to guess what the local Makefile.am should look like:
 232
 233 * Probably integrate with autoscan
 234 * Use various simple rules to determine what to do:
 235   * get name of top directory, sans version info
 236   * search for .c files with 'main' in them
 237     * if in main.c, use directory name for program
 238     * if in more than one, generate multiple programs
 239     * if not found, generate a library named after directory
 240   * order subdir searches correctly: lib first, src last
 241   * assume 'testsuite' dir means we are using dejagnu
 242 * maybe be smart about reading existing Makefile.am, so tool
 243   can be run for incremental changes?  You could imagine:
 244
 245         Makefile.am:
 246                 autoproject --incremental
 247
 248 ================================================================
 249
 250 Stuff NOT to do, and why:
 251
 252 consider auto-including any file that matches "*.in".
 253   [ no: po/Makefile.in shouldn't be included ]
 254
 255 must look at mkid to see how it works (for subdir usage)
 256   [ right now, it doesn't.  i don't see a simple fix right now ]
 257
 258 if configure.in not found, move up a directory and try again?  This
 259 could eliminate a common source of problems.
 260   [ this is just a bad idea ]