1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
Autothing
=========
Autothing is a set of Makefile fragments that you can `include` in
your GNU Makefiles to provide two core things:
1. Make it _easy_ to write non-recursive Makefiles. (search for the
paper "Recursive Make Considered Harmful")
2. Provide boilerplate for standard features people expect to be
implemented in Makefiles.
Between these two, it should largely obviate GNU Automake in your
projects.
The recommended including Autothing into your project is to add the
autothing repository as a `git` remote, and merge the `core` branch,
and whichever `mod-*` module branches you want into your project's
branch.
| module name | dependencies | description |
|-------------+--------------+--------------------------------------------------------------------------------------------------|
| at | | The core of Autothing |
|-------------+--------------+--------------------------------------------------------------------------------------------------|
| std | at | Provide .PHONY targets: all/build/install/uninstall/mostlyclean/clean/distclean/maintainer-clean |
| dist | std | Provide .PHONY target: dist |
| gnuconf | dist | Provide default values for user-variables from the GNU Coding Standards' Makefile Conventions |
| gnustuff | gnuconf | Provide remaining stuff from the GNU Coding Standards' Makefile Conventions |
Core (psuedo-module: at)
------------------------
As harmful as recursive make is, it's historically been difficult to
to write non-recursive Makefiles. The goal of the core of Autothing
is to make it easy.
In each source directory, you write a `Makefile`, very similarly to if
you were writing for plain GNU Make, with the form:
topoutdir ?= ...
topsrcdir ?= ...
include $(topsrcdir)/build-aux/Makefile.head.mk
# your makefile
include $(topsrcdir)/build-aux/Makefile.tail.mk
| at.path | Use $(call at.path,FILENAME1 FILENAME2...) sanitize filenames that are not in the current Makefile's directory or its children |
| at.nl | A newline, for convenience, since it is difficult to type a newline in GNU Make expressions |
| at.dirlocal | Which variables to apply the namespacing mechanism to |
| at.phony | Which targets to mark as .PHONY, and have automatic recursive dependencies |
| at.subdirs | Which directories to consider as children of this one |
| at.depdirs | Which directories are't subdirs, but may contain dependencies of targets in this directory |
outdir
srcdir
Module: std
-----------
| Variable | Create Command | Delete Command | Description | Relative to |
|---------------+----------------+-----------------------------+-----------------------------------+-------------|
| std.src_files | emacs | rm -rf . | Files that the developer writes | srcdir |
| std.gen_files | ??? | make maintainer-clean | Files the developer compiles | srcdir |
| std.cfg_files | ./configure | make distclean | Users' compile-time configuration | outdir |
| std.out_files | make all | make mostlyclean/make clean | Files the user compiles | outdir |
| std.sys_files | make install | make uninstall | Files the user installs | DESTDIR |
In addition, there are two more variables that control not how files
are created, but how they are deleted:
| Variable | Affected command | Description | Relative to |
|-----------------+------------------+------------------------------------------------+-------------|
| std.clean_files | make clean | A list of things to `rm` in addition to the | outdir |
| | | files in `$(std.out_files)`. (Example: `*.o`) | |
|-----------------+------------------+------------------------------------------------+-------------|
| std.slow_files | make mostlyclean | A list of things that (as an exception) should | outdir |
| | | _not_ be deleted. (otherwise, `mostlyclean` | |
| | | is the same as `clean`) | |
| Variable | Default | Description |
|----------+----------+-------------|
| DESTDIR | | |
|----------+----------+-------------|
| RM | rm -f | |
| RMDIR_P | rmdir -p | |
| TRUE | true | |
Module: dist
------------
The `dist` module produces distribution tarballs
| Variable | Default | Description |
|--------------+------------+-------------|
| dist.exts | .tar.gz | |
| dist.pkgname | $(PACKAGE) | |
| dist.version | $(VERSION) | |
| Variable | Default | Description |
|-----------+-------------+----------------------------------------------------|
| CP | cp | |
| GZIP | gzip | |
| MKDIR | mkdir | |
| MKDIR_P | mkdir -p | |
| MV | mv | |
| RM | rm -f | |
| TAR | tar | |
|-----------+-------------+----------------------------------------------------|
| GZIPFLAGS | $(GZIP_ENV) | |
| GZIP_ENV | --best | Because of GNU Automake, users expect this to work |
Module: gnuconf
---------------
The `gnuconf` module provides default values for user-facing toggles
required by the GNU Coding Standards.
There is only one developer configuration option:
| Variable | Default | Description |
|-----------------+------------+-----------------------------------------------|
| gnuconf.pkgname | $(PACKAGE) | The package name to use in the default docdir |
There is an extensive list of user configuration options:
| Variable | Default | Description |
|-----------------+---------------------------------------+-------------------------------------------|
| AWK | awk | |
| CAT | cat | |
| CMP | cmp | |
| CP | cp | |
| DIFF | diff | |
| ECHO | echo | |
| EGREP | egrep | |
| EXPR | expr | |
| FALSE | false | |
| GREP | grep | |
| INSTALL_INFO | install-info | |
| LN | ln | |
| LS | ls | |
| MKDIR | mkdir | |
| MV | mv | |
| PRINTF | printf | |
| PWD | pwd | |
| RM | rm | |
| RMDIR | rmdir | |
| SED | sed | |
| SLEEP | sleep | |
| SORT | sort | |
| TAR | tar | |
| TEST | test | |
| TOUCH | touch | |
| TR | tr | |
| TRUE | true | |
|-----------------+---------------------------------------+-------------------------------------------|
| AR | ar | |
| ARFLAGS | | |
| BISON | bison | |
| BISONFLAGS | | |
| CC | cc | |
| CCFLAGS | $(CFLAGS) | |
| FLEX | flex | |
| FLEXFLAGS | | |
| INSTALL | install | |
| INSTALLFLAGS | | |
| LD | ld | |
| LDFLAGS | | |
| LDCONFIG | ldconfig | TODO: detect absence, fall back to `true` |
| LDCONFIGFLAGS | | |
| LEX | lex | |
| LEXFLAGS | $(LFLAGS) | |
| MAKEINFO | makeinfo | |
| MAKEINFOFLAGS | | |
| RANLIB | ranlib | TODO: detect absence, fall back to `true` |
| RANLIBFLAGS | | |
| TEXI2DVI | texi2dvi | |
| TEXI2DVIFLAGS | | |
| YACC | yacc | |
| YACCFLAGS | $(YFLAGS) | |
|-----------------+---------------------------------------+-------------------------------------------|
| CFLAGS | | |
| LFLAGS | | |
| YFLAGS | | |
|-----------------+---------------------------------------+-------------------------------------------|
| LN_S | ln -s | TODO: detect when to fall back to `cp` |
|-----------------+---------------------------------------+-------------------------------------------|
| CHGRP | chgrp | |
| CHMOD | chmod | |
| CHOWN | chown | |
| MKNOD | mknod | |
|-----------------+---------------------------------------+-------------------------------------------|
| INSTALL_PROGRAM | $(INSTALL) | |
| INSTALL_DATA | ${INSTALL} -m 644 | |
|-----------------+---------------------------------------+-------------------------------------------|
| prefix | /usr/local | |
| exec_prefix | $(prefix) | |
|-----------------+---------------------------------------+-------------------------------------------|
| bindir | $(exec_prefix)/bin | |
| sbindir | $(exec_prefix)/sbin | |
| libexecdir | $(exec_prefix)/libexec | |
|-----------------+---------------------------------------+-------------------------------------------|
| datadir | $(datarootdir) | |
| sysconfdir | $(prefix)/etc | |
| sharedstatedir | $(prefix)/com | |
| localstatedir | $(prefix)/var | |
| runstatedir | $(localstatedir)/run | |
|-----------------+---------------------------------------+-------------------------------------------|
| includedir | $(prefix)/include | |
| oldincludedir | /usr/include | |
| docdir | $(datarootdir)/doc/$(gnuconf.pkgname) | |
| infodir | $(datarootdir)/info | |
| htmldir | $(docdir) | |
| dvidir | $(docdir) | |
| pdfdir | $(docdir) | |
| psdir | $(docdir) | |
| libdir | $(exec_prefix)/lib | |
| lispdir | $(datarootdir)/emacs/site-lisp | |
| localedir | $(datarootdir)/locale | |
|-----------------+---------------------------------------+-------------------------------------------|
| mandir | $(datarootdir)/man | |
| man1dir | $(mandir)/man1 | |
| man2dir | $(mandir)/man2 | |
| man3dir | $(mandir)/man3 | |
| man4dir | $(mandir)/man4 | |
| man5dir | $(mandir)/man5 | |
| man6dir | $(mandir)/man6 | |
| man7dir | $(mandir)/man7 | |
| man8dir | $(mandir)/man8 | |
|-----------------+---------------------------------------+-------------------------------------------|
| manext | .1 | |
| man1ext | .1 | |
| man2ext | .2 | |
| man3ext | .3 | |
| man4ext | .4 | |
| man5ext | .5 | |
| man6ext | .6 | |
| man7ext | .7 | |
| man8ext | .8 | |
Module: gnustuff
----------------
This is a poorly-thought-out module implementing remaining things from
the GNU Coding Standards.
This is poorly thought out and poorly tested because it's basically
the part of the GNU Coding Standards that I don't use.
Developer configuration options:
| Variable | Default | Description |
|-----------------------+-----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------|
| gnustuff.info_docs | | The list of texinfo documents in the current directory, without the `.texi` suffix. |
| gnustuff.program_dirs | $(bindir) $(sbindir) $(libexecdir) | Directories to use $(INSTALL_PROGRAM) for inserting files into. |
| gnustuff.data_dirs | <every variable from gnuconf ending in `dir` that isn't bindir, sbindir, or libexecdir> | Directories to use $(INSTALL_DATA) for inserting files into. |
| gnustuff.dirs | $(gnustuff.program_dirs) $(gnustuff.data_dirs) | Directories to create |
User configuration options:
| Variable | Default | Description |
|-----------+-----------------+-------------|
| STRIP | strip | |
| TEXI2HTML | makeinfo --html | |
| TEXI2PDF | texi2pdf | |
| TEXI2PS | texi2dvi --ps | |
| MKDIR_P | mkdir -p | |
It provides several `.phony` targets:
- install-{html,dvi,pdf,ps}
- install-strip
- {info,html,dvi,pdf,ps}
- TAGS
- check
- installcheck
It also augments the `std` `install` rule to run $(INSTALL_INFO) as
necessary.
And several real rules:
- How to install files into any of the $(gnustuff.program_dirs) or
$(gnustuff.data_dirs).
- How to generate info, dvi, html, pdf, and ps files from texi files.
|
