docs: forgot TAR in NEWS; fix " -- " in manual.
[automake.git] / old / TODO
1 the new YFLAGS code doesn't correctly handle srcdir
3 allow foo_NAME to rename an object (library or program)
4 at build/install time
6 remove _LTLIBRARIES and just use _LIBRARIES
7 then use this for zip/jar as well
9 add an error if the user violates our
10    namespace rules
12 we need a document describing automake from the end user's point of view
13 eg describe INSTALL_HEADER there, among other things
15 * maintainer-clean
17 Akim:
18 > @@ -31,5 +31,9 @@
19 >  DISTCLEAN    -test -z "$(DISTCLEANFILES)" || rm -f $(DISTCLEANFILES)
21 >  maintainer-clean-generic:
22 > +## FIXME: shouldn't we really print these messages before running
23 > +## the dependencies?
24 > +     @echo "This command is intended for maintainers to use"
25 > +     @echo "it deletes files that may require special tools to rebuild."
26 >         -rm -f
28 Tom:
29 > I'd like to eventually fix the FIXME comment by having
30 > maintainer-clean look like:
32 >     maintainer-clean:
33 >         @echo ...
34 >         $(MAKE) whatever
36 > We're left with the question of whether we should repeat them in every
37 > subdir.
40 Alexandre Oliva:
41 > Hmm...  Interesting.  It must have been a side effect of the enabling
42 > of forced `relink' on GNU/Linux/x86.  Anyway, on platforms that
43 > actually require relinking, this problem remains, and I see no way to
44 > overcome it other than arranging for automake to install libraries
45 > before executables, as you suggest.  This shouldn't be a big problem,
46 > anyway.
48 > A bigger problem could show up if two libraries in the same directory,
49 > one dependent on the other, are installed concurrently.  If relinking
50 > is needed for the dependent library, we have a problem.  It appears to
51 > me that user will have to live without `make -j install', in this
52 > case.
54 Alex Hornby
55 > Here's an Automake patch and changelog entry allow make -j install on
56 > such degenerate systems (and Linux with buggy libtool <g>)
58 > If you install to locations other that bin_ and lib_ then a larger fix
59 > is necessary, but this should fix the 90% case.
61 * think about how per-object flags should work.  in particular:
62   * how should they be specified?
63     using the object name is confusing when .lo/.obj in use
64     however, the object name provides a nice interaction with
65     per-exe flags
66   * how should they interact with per-executable flags?
67   [ this is probably a feature in search of a problem ]
69 * cross-compilation support:
70   programs built and used by the build process need to be
71   built for CC_FOR_BUILD
72   introduce a new prefxi for this, e.g. `build_PROGRAMS'
73   [ we can do this in an automatic way I think.
74     unfortunately it isn't that useful until autoconf has support
75     for this sort of thing as well ]
77 * one performance enhancement would be to have autoconf write
78   a single file containing all the macro assignments.
79   then read this file via `include'
80   unfortunately this can't be done because of conditionals
81   -- but it could be made to work if we also changed:
82     * automake to rewrite @FOO@ to $(FOO), and
83     * the implementation of conditionals to rely on some new
84       config.status magic
86 * support prog_LIBS as override for LIBS
88 * Test subdir-objects option with yacc, lex, ansi2knr
89   Our locking scheme won't prevent a parallel make from losing
90   if there are two `bar.o' files and the timing is just right
91   This only happens with parallel make and no-`-c -o' compiler,
92   so it probably isn't very important
93   `-c -o' when doing libtool
94   try to find a losing compiler and see if it really works.
95   (actually: hack config.cache and do it)
97 * per-exe flags
98 ** LIBOBJS shouldn't be used when there are per-exe flags (?)
100 * Allow creation of Java .zip/.jar files in natural way
101   If you are building a compiled Java library, then the .zip/.jar
102   ought to be made automatically.
104 * examine possibility of using any character in a macro name
105   and rewriting names automatically.  this means we must rewrite
106   all references as well.
107   [ this is a 2.0-style feature ]
109 * `distcheck' and `dist' should depend on `all'
111 * Add code to generate foo-config script like gnome, gtk
113 * document user namespace for macro/target names
114   adopt some conventions and use uniformly
115     [ this is a good thing for the rewrite ]
117 * distclean must remove config.status
118   can't this cause problems for maintainer-clean?
119   shouldn't maintainer-clean print the message before running
120   any part of the make?  (just to slow things down long enough
121   for the user to stop it)
122   (maybe doesn't matter since people who even know about
123   maintainer-clean already have a clue)
125 * reintroduce AM_FUNC_FNMATCH which sets LIBOBJS
126   Then have automake know about fnmatch.h.
127     [ probably should wait for autoconf to get right functionality ]
129 * "make diff" capability
130   look at gcc's to see what to do
131   or look at maint program
133 * in --cygnus, clean-info not generated at top level
135 * what if an element of a scanned variable looks like
136         $(FOO).$(BAR)  ?
137   or some other arbitrary thing?
138   right now we try to cope, but not very well
139     [ this is only of theoretical interest for now ]
140     [ We now have an 'inner_expand' option to traverse_recursively,
141       but it is not yet used. ]
143 * make sure every variable that is used is also defined
144     [ we don't really look at variable uses in detail.
145       2.0 thing ]
147 * make sure `missing' defines are generated
149 * missing should handle install -d and rmdir -p (for uninstall)
151 * NORMAL_INSTALL / NORMAL_UNINSTALL -vs- recursive rules
152   [ requires changes to the standard ]
154 * should not put texiname_TEXINFOS into distribution
155   should rename this macro anyway, to foo_texi_DEPENDENCIES
157 * For now I guess I'll just have automake give an error if it encounters
158 non-C source in a libtool library specification.
160 * if program has the same name as a target, do something sensible:
161   - if the target is internal, rename it
162   - if the target is mandated (eg, "info"), tell the user
163     consider auto-modifying the program name to work around this
165 * should separate actual options from strictness levels
166   strictness should only cover requirements
167   You should be able to pick and choose options
169 having just one Makefile for a project would give a big speed increase
170 for a project with many directories, eg glibc.  ideally (?) you'd
171 still be able to have a in each directory somehow; this
172 might make editing conceptually easier.
174 * finish up TAGS work
176 * only remove libtool at top level?
178 * clean up source directory by moving stuff into subdirs
180 * consider adding other variables similar to pkglibexecdir?
181   requests for pkg-dirs with version included
183 Avoid loops when installing; instead unroll them in automake
184 [ Impossible when @AC_SUBST@ values are used. ]
186 Some long-term projects:
187 * if $(FOO) is used somewhere, ensure FOO is defined, either by
188   user or by automake if possible
190 [ include, += support ]
191 * even better would be allowing targets in different included
192   fragments to be merged.  e.g., `install-local'.
194 consider putting all check-* targets onto @check?
196 take diff-n-query code from libit
198 Per Bothner says:
199 Per> 1) Being able to build a set of non-source programs
200 Per> from source programs, without necessarily linking them together.
201 Per> I.e. one should be able to say something like:
202 Per>    dummy_SOURCES=foo.c bar.c
203 Per> and automake should realize that it needs to build foo.o and bar.o.
204 Per> 2) Being intelligent about new kinds of suffixes.
205 Per> If it sees:
206 Per>    SUFFIXES = .class .java
207 Per> and a suffix rule of the form:
208 Per>    .java.class:
209 Per> then it should be able to realize it can build .class files from
210 Per> .java files, and thus be able to generate a list of
211 Per> .class files from a list of .java source files.
212 [What Per wanted here was a way to have automate automatically follow
213 suffix rules.  So for instance if you had a `.x.y:' rule, and automake
214 saw a `.x' file, it would automatically build and install the
215 corresponding `.y' file.]
217 Jim's idea: should look for @setfilename and warn if filenames too long
218 * guess split size
220 from joerg-martin schwarz:
221  -- If contains $(CC), $(COMPILE), $(YLWRAP), ....
222     in an explicitly written rule,  you should emit the corresponding
223     Makefile variables automatically.
225 From the GNU Standards.  These things could be checked, and probably
226 should be if --gnu.
227 *    Make sure that the directory into which the distribution unpacks (as
228 well as any subdirectories) are all world-writable (octal mode 777).
229 *   Make sure that no file name in the distribution is more than 14
230 characters long.
231 *    Don't include any symbolic links in the distribution itself.
232      (ditto hard links)
233 *    Make sure that all the files in the distribution are world-readable.
235 should be able to determine what is built by looking at rules (and
236  Then built man pages (eg) could automatically be
237 omitted from the distribution.
239 Right now, targets generated internally (eg "install") are not
240 overridable by user code.  This should probably be possible, even
241 though it isn't very important.  This could be done by generating all
242 internal rules via a function call instead of just appending to
243 $output_rules.
244  [ this will be harder to implement when scanning a rule like all-recursive
245    from ]
247 Other priorities:
248 * Must rewrite am_install_var.  Should break into multiple functions.
249   This will allow the callers to be a little smarter.
250 * Rewrite clean targets.
251 * Fix up require_file junk.
253 djm wants ``LINKS'' variable; list of things to link together after
254 install.  In BSD environment, use:
255         LINKS = from1 to1 from2 to2 ...
257 Need way to say there are no suffixes in a Makefile (Franc,ois'
258 "override" idea suffices here)
260 Check to make sure various scripts are executable (IE when looking for
261 them in a directory)
263 Add support for html via an option.  Use texi2html.  Use
264 "html_TEXINFOS", and htmldir = .../html.  Include html files in
265 distribution.  Also allow "html_DATA", for raw .html files.
266   [ when will texinfo directly support html? ]
267 See also Karl Berry's message on a roadmap for a "info -> html"
268 transition:
269 <>
271 uninstall and pkg-dirs should rm -rf the dir.
273 In general most .am files should be merged into automake.  For
274 instance all the "clean" targets could be merged by keeping lists of
275 things to be removed.  This would be a lot nicer looking.  Note that
276 the install targets probably should not be merged; it is sometimes
277 useful to only install a small part.
279 * Lex, yacc support:
280 ** It would be nice to automatically support using bison's better features
281   to rename the output files.  This requires autoconf support
282 ** Consider supporting syntax from autoconf "derived:source", eg:
284   for yacc and lex source
285 ** what if you use flex and the option to avoid -lfl?
286   should support this?
288 * Multi-language support:
289 ** should have mapping of file extensions to languages
290 ** should automatically handle the linking issue (special-case C++)
291 ** must get compile rules for various languages; FORTRAN probably
292   most important unimplemented language
293 This should be integrated in some way with Per's idea.
294 Eg .f.o rules should be recognized & auto-handled in _SOURCES
295 That way any random language can be treated with C/C++ on a first-class
296 basis (maybe)
298 It might be cool to generate .texi dependencies by grepping for
299 @include.  (If done, it should be done the same way C dependencies are
300 done)
301 [ Ask Karl Berry for a -M option to makeinfo and texi2dvi? ]
303 It would be good to check some parts of GNU standards.  Already check
304 for install-sh and mkinstalldirs.  What else is required to be in
305 package by GNU standards or by automake?
306 Some things for --strictness=gnits:
307 * "cd $(foo); something" is an error in a rule.  Should be:
308   "cd $(foo) && something"
309 * Look for 'ln -s' and warn about using $(LN_S) and AC_PROG_LN_S
310 * Look for $(LN_S) and require AC_PROG_LN_S
312 Auto-distribute "ChangeLog.[0-9]+"?  "ChangeLog.[a-z]+"?
314 Check all source files to make sure that FSF address is up-to-date.
315 --gnits or --gnu only.
317 Merge each file with corresponding ".am" file.  Can do this
318 because of changes to &file_contents.
320 Should libexec programs have the name transform done on them?
322 Order the output rules sensibly, so FOO_SOURCES and FOO_OBJECTS are
323 together and rules are in the usual order.
325 djm says:
326 David> To avoid comments like the one about subdirs getting buried in
327 David> the middle of a, how about pushing comments that
328 David> start with ### to the top of the (in order)?  Sort
329 David> of like how Autoconf uses diversions to force initialization
330 David> code to the top of configure.
332 ================================================================
334 Stuff for aclocal:
336 probably should put each group of m4 files into a subdir owned by the
337 containing application.
339 ================================================================
341 Document:
345 how to use the generated makefiles
346  - standard targets
347  - required targets
348  - NORMAL_INSTALL junk
350 rationale for avoiding
351         make CFLAGS="$CFLAGS" ...
352 in subdirs make rule
354 write example of using automake with dejagnu
355 follow calc example in dejagnu docs
357 document which variables are actually scanned and which are not.
359 Document customary ordering of  From Fran├žois.
361 Should include extended version of diagram from Autoconf (suggested by
362 Greg Woods)
364 Make a definition of the term "source"
366 document how to use Automake with CVS.  Idea from Mark Galassi.  Also
367 include Greg Woods' more sophisticated "cvs-dist" target.
369 -- must document all variables that are supposed
370    to be public knowledge
372 must document the targets required for integration with
373 non-automake-using subdirs
375 document the "make SHELL='/bin/sh -x'" trick for debugging
377 section on relationship to GNU make.  include notes on parallel makes
379 add a concept index
381 move discussion of cygwin32, etags, mkid under other gnu tools
385 ================================================================
387 Libraries:
389 * Should support standalone library along with subdir library in same
390  Maybe: turn off "standalone" mode if library's
391   is not only one specd? [ add an option for this ]
393 ================================================================
395 Longer term:
397 Would it be useful to integrate in some way with the Debian package
398 building utility?  Must check.  maybe it would be possible to deal
399 with all the different package utilities somehow.  Lately I've been
400 hearing good things about the RedHat packaging utilities.  Why are
401 there so many of these?  Are they fun to write or something?
402 The RedHat package utility is called RPM; see
404 It actually has problems, like no configure script and no documentation.
406 For Cygnus it would probably be good to be able to handle the native
407 package utility on each platform.  There are probably 3 or 4 of these
408 (sysv, solaris?, aix?)
410 tcl/unix/ has some code to generate a Solaris package.
412 Automake probably can't do all of this on its own.  A new tool might
413 be a better idea
415 I have some notes from a Debian developer on how the integration
416 should work
418 ================================================================
420 A tool to guess what the local should look like:
421 (see Gord's Maint program!)
423 * Probably integrate with autoscan
424 * Use various simple rules to determine what to do:
425   * get name of top directory, sans version info
426   * search for .c files with 'main' in them
427     * if in main.c, use directory name for program
428     * if in more than one, generate multiple programs
429     * if not found, generate a library named after directory
430   * order subdir searches correctly: lib first, src last
431   * assume 'testsuite' dir means we are using dejagnu
432 * maybe be smart about reading existing, so tool
433   can be run for incremental changes?  You could imagine:
436                 autoproject --incremental
438 ================================================================
440 Stuff NOT to do, and why:
442 consider auto-including any file that matches "*.in".
443   [ no: po/ shouldn't be included ]
445 must look at mkid to see how it works (for subdir usage)
446   [ right now, it doesn't.  i don't see a simple fix right now ]
448 if not found, move up a directory and try again?  This
449 could eliminate a common source of problems.
450   [ this is just a bad idea ]
452 * scripts are installed in $exec_prefix/bin, not $prefix/bin
453   Bug or feature?
454   [ the consensus on Gnits is that this isn't required.
455     doubters can work around it anyway ]
457 Scan source directories and warn about missing files, eg .c/.h files
458 that aren't mentioned?
459   [ distcheck makes this less useful ]
461 * quoting bugs
462   - how to install file with a space in its name?
463   [ don't bother with this -- make is just too losing ]
465 * notice when a .c file is a target somewhere, and auto-add it to
467   [ BUILT_SOURCES are for files that need to be built before anything
468     else because of hidden dependencies (something .c files are
469     unlikely to be) ]
471 * Scan multiple input files when Makefile is generated?
472   This would provide flexibility for large projects; subsumes
473   the "Makefile.tmpl" idea
474  [ can't do this.  must explain why in manual.
475    basically, solving all the problems is too hard
476    like: how to remove redundancies between generated .in files
477    instead should implement `include' directive for ]
479 * Should be a way to have "nobuild_PROGRAMS" which aren't even built,
480   but which could be by running the magic make command.
481   [ We already have EXTRA_PROGRAMS for this. ]
484 * copyright notice
486 Copyright 1994-2020 Free Software Foundation, Inc.
488 This program is free software; you can redistribute it and/or modify
489 it under the terms of the GNU General Public License as published by
490 the Free Software Foundation; either version 2, or (at your option)
491 any later version.
493 This program is distributed in the hope that it will be useful,
494 but WITHOUT ANY WARRANTY; without even the implied warranty of
496 GNU General Public License for more details.
498 You should have received a copy of the GNU General Public License
499 along with this program.  If not, see <>.
502 Local Variables:
503 mode: outline
504 End: