diff options
| -rw-r--r-- | README.md | 283 | ||||
| -rw-r--r-- | build-aux/Makefile.README.txt | 164 | ||||
| -rw-r--r-- | build-aux/Makefile.each.head/.gitignore | 0 | ||||
| -rw-r--r-- | build-aux/Makefile.each.head/00-dist.mk | 20 | ||||
| -rw-r--r-- | build-aux/Makefile.each.tail/.gitignore | 0 | ||||
| -rw-r--r-- | build-aux/Makefile.each.tail/10-std.mk | 53 | ||||
| -rw-r--r-- | build-aux/Makefile.each.tail/11-gnustuff.mk | 60 | ||||
| -rw-r--r-- | build-aux/Makefile.head.mk | 63 | ||||
| -rw-r--r-- | build-aux/Makefile.once.head/.gitignore | 0 | ||||
| -rw-r--r-- | build-aux/Makefile.once.head/00-dist.mk | 44 | ||||
| -rw-r--r-- | build-aux/Makefile.once.head/00-write-ifchanged.mk | 1 | ||||
| -rw-r--r-- | build-aux/Makefile.once.head/10-std.mk | 39 | ||||
| -rw-r--r-- | build-aux/Makefile.once.head/11-gnustuff.mk | 34 | ||||
| -rw-r--r-- | build-aux/Makefile.once.tail/.gitignore | 0 | ||||
| -rw-r--r-- | build-aux/Makefile.once.tail/00-dist.mk | 27 | ||||
| -rw-r--r-- | build-aux/Makefile.once.tail/11-gnustuff.mk | 17 | ||||
| -rw-r--r-- | build-aux/Makefile.tail.mk | 51 | ||||
| -rwxr-xr-x | build-aux/write-ifchanged | 25 | ||||
| -rw-r--r-- | config.mk.in | 114 |
19 files changed, 995 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e7606eb --- /dev/null +++ b/README.md @@ -0,0 +1,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. diff --git a/build-aux/Makefile.README.txt b/build-aux/Makefile.README.txt new file mode 100644 index 0000000..e06ba52 --- /dev/null +++ b/build-aux/Makefile.README.txt @@ -0,0 +1,164 @@ +Luke's AutoMake +=============== + +Yo, this document is incomplete. It describes the magical +automake.{head,tail}.mk Makefiles and how to use them, kinda. + +I wrote a "clone" of automake. I say clone, because it works +differently. Yeah, I need a new name for it. + +High-level overview +------------------- + +Now, what this does for you is: + +It makes it _easy_ to write non-recursive Makefiles--and ones that are +similar to plain recursive Makefiles, at that! (search for the paper +"Recursive Make Considered Harmful") As harmful as recursive make is, +it's historically been difficult to to write non-recursive Makefiles. +This makes it easy. + +It also makes it easy to follow the GNU standards for your makefiles: +it takes care of this entire table of .PHONY targets for you: + +| this | and this | are aliases for this | +|------+------------------+--------------------------------------------------------| +| all | build | $(outdir)/build | +| | install | $(outdir)/install | +| | uninstall | $(outdir)/uninstall | +| | mostlyclean | $(outdir)/mostlyclean | +| | clean | $(outdir)/clean | +| | distclean | $(outdir)/distclean | +| | maintainer-clean | $(outdir)/maintainer-clean | +| | check | $(outdir)/check (not implemented for you) | +| | dist | $(topoutdir)/$(PACKAGE)-$(VERSION).tar.gz (not .PHONY) | + +(You are still responsible for implementing the `$(outdir)/check` +target in each of your Makefiles.) + +What you have to do is: + +In each source directory, you write a `Makefile`, very similarly to if +you were writing for plain GNU Make, with + + topoutdir ?= ... + topsrcdir ?= ... + include $(topsrcdir)/build-aux/Makefile.head.mk + + # your makefile + + include $(topsrcdir)/build-aux/Makefile.tail.mk + +And in the top-level source directory, Write your own helper makefiles +that get included: + - `common.once.head.mk`: before parsing any of your Makefiles + - `common.each.head.mk`: before parsing each of your Makefiles + - `common.each.tail.mk`: after parsing each of your Makefiles + - `common.each.tail.mk`: after parsing all of your Makefiles + +The `common.*.mk` makefiles are nice for including generic pattern +rules and variables that aren't specific to a directory. + +You're probably thinking that this sounds too good to be true! +Unfortunately, there are two major deviations from writing a plain +recursive Makefile: + + 1. all targets and prerequisites (including .PHONY targets!) need to + be prefixed with + `$(srcdir)`/`$(outdir)`/`$(topsrcdir)`/`$(topoutdir)`. + * sub-gotcha: this means that if a pattern rule has a + prerequisite that may be in srcdir or outdir, then it must be + specified twice, once for each case. + 2. if a prerequisite is in a directory "owned" by another Makefile, + you must filter the pathname through `am_path`: + `$(call am_path,YOUR_PATH)`. Further, that path must NOT contain + a `..` segment; if you need to refer to a sibling directory, do it + relative to `$(topoutdir)` or `$(topsrcdir)`. + +Telling automake about your program +----------------------------------- + +You tell automake what to do for you by setting some variables. They +are all prefixed with `am_`; this prefix may be changed by editing the +`_am` variable at the top of `automake.head.mk`. + +The exception to this is the `am_path` variable, which is a macro that +is used to make a list of filenames relative to the appropriate +directory, because unlike normal GNU (Auto)Make, `$(outdir)` isn't +nescessarily equal to `.`. See above. + +There are several commands that generate files; simply record the list +of files that each command generates as the following variable +variables: + +| Variable | Create Command | Delete Command | Description | Relative to | +|--------------+----------------+-----------------------------+-----------------------------------+-------------| +| am_src_files | emacs | rm -rf . | Files that the developer writes | srcdir | +| am_gen_files | ??? | make maintainer-clean | Files the developer compiles | srcdir | +| am_cfg_files | ./configure | make distclean | Users' compile-time configuration | outdir | +| am_out_files | make all | make mostlyclean/make clean | Files the user compiles | outdir | +| am_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 | +|----------------+------------------+------------------------------------------------+-------------| +| am_clean_files | make clean | A list of things to `rm` in addition to the | outdir | +| | | files in `$(am_out_files)`. (Example: `*.o`) | | +|----------------+------------------+------------------------------------------------+-------------| +| am_slow_files | make mostlyclean | A list of things that (as an exception) should | outdir | +| | | _not_ be deleted. (otherwise, `mostlyclean` | | +| | | is the same as `clean`) | | + +Finally, there are two variables that express the relationships +between directories: + +| Variable | Description | +|------------+---------------------------------------------------------| +| am_subdirs | A list of other directories (containing Makefiles) that | +| | may be considered "children" of this | +| | directory/Makefile; building a phony target in this | +| | directory should also build it in the subdirectory. | +| | They are not necesarily actually subdirectories of this | +| | directory in the filesystem. | +|------------+---------------------------------------------------------| +| am_depdirs | A list of other directories (containing Makefiles) that | +| | contain or generate files that are dependencies of | +| | targets in this directory. They are not necesarily | +| | actually subdirectories of this directory in the | +| | filesystem. Except for files that are dependencies of | +| | files in this directory, things in the dependency | +| | directory will not be built. | + +Tips, notes +----------- + +I like to have the first (non-comment) line in a Makefile be: + + include $(dir $(lastword $(MAKEFILE_LIST)))/../../config.mk + +(adjusting the number of `../` sequences as nescessary). Then, my +(user-editable) `config.mk` is of the form: + + ifeq ($(topsrcdir),) + topoutdir := $(patsubst %/,%,$(dir $(lastword $(MAKEFILE_LIST)))) + topsrcdir := $(topoutdir) + + # your configuration + + endif + +If the package has a `./configure` script, then I have it modifiy +topsrcdir as necessary, as well as modifying whatever other parts of +the configuration. All of the configuration lives in `config.mk`; +`./configure` doesn't modify any `Makefile`s, it just generates +`config.mk`, and copies (or (sym?)link?) every `$(srcdir)/Makefile` to +`$(outdir)/Makefile`. + +---- +Copyright (C) 2016 Luke Shumaker + +This documentation file is placed into the public domain. If that is +not possible in your legal system, I grant you permission to use it in +absolutely every way that I can legally grant to you. diff --git a/build-aux/Makefile.each.head/.gitignore b/build-aux/Makefile.each.head/.gitignore new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/build-aux/Makefile.each.head/.gitignore diff --git a/build-aux/Makefile.each.head/00-dist.mk b/build-aux/Makefile.each.head/00-dist.mk new file mode 100644 index 0000000..a094305 --- /dev/null +++ b/build-aux/Makefile.each.head/00-dist.mk @@ -0,0 +1,20 @@ +# Copyright (C) 2015-2016 Luke Shumaker +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +ifeq ($(outdir),$(topoutdir)) +std.clean_files += $(addprefix $(dist.pkgname)-*,$(dist.exts) .tar /) +endif + +$(outdir)/dist: $(addprefix $(topoutdir)/$(dist.pkgname)-$(dist.version),$(dist.exts)) diff --git a/build-aux/Makefile.each.tail/.gitignore b/build-aux/Makefile.each.tail/.gitignore new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/build-aux/Makefile.each.tail/.gitignore diff --git a/build-aux/Makefile.each.tail/10-std.mk b/build-aux/Makefile.each.tail/10-std.mk new file mode 100644 index 0000000..693f39d --- /dev/null +++ b/build-aux/Makefile.each.tail/10-std.mk @@ -0,0 +1,53 @@ +# Copyright (C) 2015-2016 Luke Shumaker +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +# Add some more defaults to the *_files variables +std.clean_files += $(std.gen_files) $(std.cfg_files) $(std.out_files) + +# Fix each variable at its current value to avoid any weirdness +$(foreach c,src gen cfg out sys clean slow,$(eval std.$c_files := $$(std.$c_files))) + +# Make each of the standard variables relative to the correct directory +std.src_files := $(patsubst ./%,%,$(addprefix $(srcdir)/,$(std.src_files))) +std.gen_files := $(patsubst ./%,%,$(addprefix $(srcdir)/,$(std.gen_files))) +std.cfg_files := $(patsubst ./%,%,$(addprefix $(outdir)/,$(std.cfg_files))) +std.out_files := $(patsubst ./%,%,$(addprefix $(outdir)/,$(std.out_files))) +std.sys_files := $(addprefix $(DESTDIR),$(std.sys_files)) +std.clean_files := $(patsubst ./%,%,$(addprefix $(outdir)/,$(std.clean_files))) +std.slow_files := $(patsubst ./%,%,$(addprefix $(outdir)/,$(std.slow_files))) + +# Creative targets +$(outdir)/build : $(std.out_files) +$(outdir)/install : $(std.sys_files) +$(outdir)/installdirs: $(sort $(dir $(std.sys_files))) + +# Destructive targets +_std.uninstall/$(outdir) := $(std.sys_files) +_std.mostlyclean/$(outdir) := $(filter-out $(std.slow_files) $(std.cfg_files) $(std.gen_files) $(std.src_files),$(std.clean_files)) +_std.clean/$(outdir) := $(filter-out $(std.cfg_files) $(std.gen_files) $(std.src_files),$(std.clean_files)) +_std.distclean/$(outdir) := $(filter-out $(std.gen_files) $(std.src_files),$(std.clean_files)) +_std.maintainer-clean/$(outdir) := $(filter-out $(std.src_files),$(std.clean_files)) +$(addprefix $(outdir)/,mostlyclean clean distclean maintainer-clean): %: %-hook + $(RM) -- $(sort $(filter-out %/,$(_std.$(@F)/$(@D)))) + $(RM) -r -- $(sort $(filter %/,$(_std.$(@F)/$(@D)))) + $(RMDIR_P) $(sort $(dir $(_std.$(@F)/$(@D)))) 2>/dev/null || $(TRUE) +# separate uninstall to support GNU Coding Standards' NORMAL_UNINSTALL +$(addprefix $(outdir)/,uninstall): %: %-hook + $(NORMAL_UNINSTALL) + $(RM) -- $(sort $(filter-out %/,$(_std.$(@F)/$(@D)))) + $(RM) -r -- $(sort $(filter %/,$(_std.$(@F)/$(@D)))) + $(RMDIR_P) $(sort $(dir $(_std.$(@F)/$(@D)))) 2>/dev/null || $(TRUE) +$(foreach t,uninstall mostlyclean clean distclean maintainer-clean, $(outdir)/$t-hook):: +.PHONY: $(foreach t,uninstall mostlyclean clean distclean maintainer-clean, $(outdir)/$t-hook) diff --git a/build-aux/Makefile.each.tail/11-gnustuff.mk b/build-aux/Makefile.each.tail/11-gnustuff.mk new file mode 100644 index 0000000..790efad --- /dev/null +++ b/build-aux/Makefile.each.tail/11-gnustuff.mk @@ -0,0 +1,60 @@ +# Copyright (C) 2016 Luke Shumaker +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +# 7.2.6: Standard Targets for Users +# --------------------------------- + +std.gen_files += $(foreach f,$(gnustuff.info_docs), $f.info ) +std.sys_files += $(foreach f,$(gnustuff.info_docs), $(infodir)/$f.info ) + +$(foreach d,$(gnustuff.program_dirs),$(eval $(call _gnustuff.install_program,$d))) +$(foreach d,$(gnustuff.data_dirs) ,$(eval $(call _gnustuff.install_data,$d))) + +#all: std +install: + $(foreach f,$(gnustuff.info_docs),$(INSTALL_INFO) $(DESTDIR)$(infodir)/$f.info $(DESTDIR)$(infodir)/dir$(at.nl)) +$(outdir)/install-html: $(foreach f,$(gnustuff.info_docs), $(DESTDIR)$(htmldir)/$f.html ) +$(outdir)/install-dvi : $(foreach f,$(gnustuff.info_docs), $(DESTDIR)$(dvidir)/$f.dvi ) +$(outdir)/install-pdf : $(foreach f,$(gnustuff.info_docs), $(DESTDIR)$(pdfdir)/$f.pdf ) +$(outdir)/install-ps : $(foreach f,$(gnustuff.info_docs), $(DESTDIR)$(psdir)/$f.ps ) +#uninstall: std +$(outdir)/install-strip: install + $(STRIP) $(filter $(addsuffix /%,$(gnustuff.program_dirs)),$(std.sys_files/$(@D))) +#clean: std +#distclean: std +#mostlyclean: std +#maintainer-clean: std +TAGS: TODO +$(outdir)/info: $(addsuffix .info,$(gnustuff.info_docs)) +$(outdir)/dvi : $(addsuffix .dvi ,$(gnustuff.info_docs)) +$(outdir)/html: $(addsuffix .html,$(gnustuff.info_docs)) +$(outdir)/pdf : $(addsuffix .pdf ,$(gnustuff.info_docs)) +$(outdir)/ps : $(addsuffix .ps ,$(gnustuff.info_docs)) +#dist:dist +check: TODO +installcheck: TODO +#installdirs: std + +$(outdir)/%.info: $(srcdir)/%.texi; $(MAKEINFO) -o $(@D) $< +$(outdir)/%.info: $(outdir)/%.texi; $(MAKEINFO) -o $(@D) $< +$(outdir)/%.dvi : $(srcdir)/%.texi; $(TEXI2DVI) -o $(@D) $< +$(outdir)/%.dvi : $(outdir)/%.texi; $(TEXI2DVI) -o $(@D) $< +$(outdir)/%.html: $(srcdir)/%.texi; $(TEXI2HTML) -o $(@D) $< +$(outdir)/%.html: $(outdir)/%.texi; $(TEXI2HTML) -o $(@D) $< +$(outdir)/%.pdf : $(srcdir)/%.texi; $(TEXI2PDF) -o $(@D) $< +$(outdir)/%.pdf : $(outdir)/%.texi; $(TEXI2PDF) -o $(@D) $< +$(outdir)/%.ps : $(srcdir)/%.texi; $(TEXI2PS) -o $(@D) $< +$(outdir)/%.ps : $(outdir)/%.texi; $(TEXI2PS) -o $(@D) $< +#installdirs: std diff --git a/build-aux/Makefile.head.mk b/build-aux/Makefile.head.mk new file mode 100644 index 0000000..63a3462 --- /dev/null +++ b/build-aux/Makefile.head.mk @@ -0,0 +1,63 @@ +# Copyright (C) 2015-2016 Luke Shumaker +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +# This bit only gets evaluated once, at the very beginning +ifeq ($(_at.NO_ONCE),) + +ifeq ($(topsrcdir),) +$(error topsrcdir must be set before including Makefile.head.mk) +endif +ifeq ($(topoutdir),) +$(error topoutdir must be set before including Makefile.head.mk) +endif + +_at.noslash = $(patsubst %/.,%,$(patsubst %/,%,$1)) +# These are all $(call _at.func,parent,child) +#at.relto = $(if $2,$(shell realpath -sm --relative-to='$1' $2)) +_at.is_subdir = $(filter $(abspath $1)/%,$(abspath $2)/.) +_at.relto_helper = $(if $(call _at.is_subdir,$1,$2),$(patsubst $1/%,%,$(addsuffix /.,$2)),$(addprefix ../,$(call _at.relto_helper,$(patsubst %/,%,$(dir $1)),$2))) +_at.relto = $(call _at.noslash,$(call _at.relto_helper,$(call _at.noslash,$(abspath $1)),$(call _at.noslash,$(abspath $2)))) +at.relto = $(foreach p,$2,$(call _at.relto,$1,$p)) +# Note that _at.is_subdir says that a directory is a subdirectory of +# itself. +at.path = $(call at.relto,.,$1) + +define at.nl + + +endef + +_at.rest = $(wordlist 2,$(words $1),$1) +_at.reverse = $(if $1,$(call _at.reverse,$(_at.rest))) $(firstword $1) + +at.dirlocal += at.subdirs +at.dirlocal += at.depdirs + +include $(sort $(wildcard $(topsrcdir)/build-aux/Makefile.once.head/*.mk)) + +endif # _at.NO_ONCE + +# This bit gets evaluated for each Makefile + +## Set outdir and srcdir (assumes that topoutdir and topsrcdir are +## already set) +outdir := $(call at.path,$(dir $(lastword $(filter-out %.mk,$(MAKEFILE_LIST))))) +srcdir := $(call at.path,$(topsrcdir)/$(call _at.relto,$(topoutdir),$(outdir))) + +_at.included_makefiles := $(_at.included_makefiles) $(call at.path,$(outdir)/Makefile) + +$(foreach v,$(at.dirlocal),$(eval $v=)) + +include $(sort $(wildcard $(topsrcdir)/build-aux/Makefile.each.head/*.mk)) diff --git a/build-aux/Makefile.once.head/.gitignore b/build-aux/Makefile.once.head/.gitignore new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/build-aux/Makefile.once.head/.gitignore diff --git a/build-aux/Makefile.once.head/00-dist.mk b/build-aux/Makefile.once.head/00-dist.mk new file mode 100644 index 0000000..d5bfcd3 --- /dev/null +++ b/build-aux/Makefile.once.head/00-dist.mk @@ -0,0 +1,44 @@ +# Copyright (C) 2015-2016 Luke Shumaker +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +# Developer configuration + +dist.exts ?= .tar.gz +dist.pkgname ?= $(PACKAGE) +dist.version ?= $(VERSION) + +ifeq ($(dist.pkgname),) +$(error dist.pkgname must be set) +endif +ifeq ($(dist.version),) +$(error dist.version must be set) +endif + +# User configuration + +CP ?= cp +GZIP ?= gzip +MKDIR ?= mkdir +MKDIR_P ?= mkdir -p +MV ?= mv +RM ?= rm -f +TAR ?= tar + +GZIPFLAGS ?= $(GZIP_ENV) +GZIP_ENV ?= --best + +# Implementation + +at.phony += dist diff --git a/build-aux/Makefile.once.head/00-write-ifchanged.mk b/build-aux/Makefile.once.head/00-write-ifchanged.mk new file mode 100644 index 0000000..79ef1c4 --- /dev/null +++ b/build-aux/Makefile.once.head/00-write-ifchanged.mk @@ -0,0 +1 @@ +WRITE_IFCHANGED = $(topsrcdir)/build-aux/write-ifchanged diff --git a/build-aux/Makefile.once.head/10-std.mk b/build-aux/Makefile.once.head/10-std.mk new file mode 100644 index 0000000..3e058ec --- /dev/null +++ b/build-aux/Makefile.once.head/10-std.mk @@ -0,0 +1,39 @@ +# Copyright (C) 2015-2016 Luke Shumaker +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +# Declare the default target +all: build +.PHONY: all noop + +# Standard creative PHONY targets +at.phony += build install installdirs +# Standard destructive PHONY targets +at.phony += uninstall mostlyclean clean distclean maintainer-clean + +at.dirlocal += std.src_files +at.dirlocal += std.gen_files +at.dirlocal += std.cfg_files +at.dirlocal += std.out_files +at.dirlocal += std.sys_files +at.dirlocal += std.clean_files +at.dirlocal += std.slow_files + +# User configuration + +DESTDIR ?= + +RM ?= rm -f +RMDIR_P ?= rmdir -p +TRUE ?= true diff --git a/build-aux/Makefile.once.head/11-gnustuff.mk b/build-aux/Makefile.once.head/11-gnustuff.mk new file mode 100644 index 0000000..800f6d2 --- /dev/null +++ b/build-aux/Makefile.once.head/11-gnustuff.mk @@ -0,0 +1,34 @@ +# Copyright (C) 2016 Luke Shumaker +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +STRIP ?= strip +TEXI2HTML ?= makeinfo --html +TEXI2PDF ?= texi2pdf +TEXI2PS ?= texi2dvi --ps +MKDIR_P ?= mkdir -p + +gnustuff.program_dirs += $(bindir) $(sbindir) $(libexecdir) +gnustuff.data_dirs += $(datarootdir) $(datadir) $(sysconfdir) $(sharedstatedir) $(localstatedir) $(runstatedir) +gnustuff.data_dirs += $(includedir) $(oldincludedir) $(docdir) $(infodir) $(htmldir) $(dvidir) $(pdfdir) $(psdir) $(libdir) $(lispdir) $(localedir) +gnustuff.data_dirs += $(mandir) $(man1dir) $(man2dir) $(man3dir) $(man4dir) $(man5dir) $(man6dir) $(man7dir) $(man8dir) + +gnustuff.info_docs ?= +std.dirlocal += gnustuff.info_docs + +gnustuff.dirs += $(gnu.program_dirs) $(gnu.data_dirs) + +at.phony += install-html install-dvi install-pdf install-ps +at.phony += info html dvi pdf ps +at.phony += install-strip diff --git a/build-aux/Makefile.once.tail/.gitignore b/build-aux/Makefile.once.tail/.gitignore new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/build-aux/Makefile.once.tail/.gitignore diff --git a/build-aux/Makefile.once.tail/00-dist.mk b/build-aux/Makefile.once.tail/00-dist.mk new file mode 100644 index 0000000..b8b7733 --- /dev/null +++ b/build-aux/Makefile.once.tail/00-dist.mk @@ -0,0 +1,27 @@ +# Copyright (C) 2015-2016 Luke Shumaker +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +_dist.copyfile = $(MKDIR_P) $(dir $2) && $(CP) -T $1 $2 +_dist.addfile = $(call _dist.copyfile,$3,$2/$(call at.relto,$1,$3)) +$(topoutdir)/$(dist.pkgname)-$(dist.version): $(foreach v,$(filter std.src_files/% std.gen_files/%,$(.VARIABLES)),$($v)) + $(RM) -r $@ $(@D)/tmp.$(@F) + $(MKDIR) $(@D)/tmp.$(@F) + $(foreach f,$^,$(call _dist.addfile,$(topsrcdir),$(@D)/tmp.$(@F),$f)$(at.nl)) + $(MV) $(@D)/tmp.$(@F) $@ || $(RM) -r $(@D)/tmp.$(@F) + +$(topoutdir)/$(dist.pkgname)-$(dist.version).tar: $(topoutdir)/$(dist.pkgname)-$(dist.version) + $(TAR) cf $@ -C $(<D) $(<F) +$(topoutdir)/$(dist.pkgname)-$(dist.version).tar.gz: $(topoutdir)/$(dist.pkgname)-$(dist.version).tar + $(GZIP) $(GZIPFLAGS) < $< > $@ diff --git a/build-aux/Makefile.once.tail/11-gnustuff.mk b/build-aux/Makefile.once.tail/11-gnustuff.mk new file mode 100644 index 0000000..df5f192 --- /dev/null +++ b/build-aux/Makefile.once.tail/11-gnustuff.mk @@ -0,0 +1,17 @@ +# Copyright (C) 2016 Luke Shumaker +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +$(gnu.dirs): + $(MKDIR_P) $@ diff --git a/build-aux/Makefile.tail.mk b/build-aux/Makefile.tail.mk new file mode 100644 index 0000000..dfbad5a --- /dev/null +++ b/build-aux/Makefile.tail.mk @@ -0,0 +1,51 @@ +# Copyright (C) 2015-2016 Luke Shumaker +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +# This bit gets evaluated for each Makefile processed + +include $(call _at.reverse,$(sort $(wildcard $(topsrcdir)/build-aux/Makefile.each.tail/*.mk))) + +at.subdirs := $(patsubst ./%,%,$(addprefix $(outdir)/,$(at.subdirs))) +at.depdirs := $(patsubst ./%,%,$(addprefix $(outdir)/,$(at.depdirs))) + +# Move all of the dirlocal variables to their namespaced version +$(foreach v,$(at.dirlocal),$(eval $v/$(outdir) := $$($v))) +$(foreach v,$(at.dirlocal),$(eval undefine $v)) + +# Remember that this is a directory that we've visited +_at.outdirs := $(_at.outdirs) $(outdir) + +# Generic phony target declarations: +# mark them phony +.PHONY: $(addprefix $(outdir)/,$(at.phony)) +# have them depend on subdirs +$(foreach t,$(at.phony),$(eval $(outdir)/$t: $(addsuffix /$t,$(at.subdirs/$(outdir))))) + +# Include Makefiles from other directories +$(foreach _at.NO_ONCE,y,\ + $(foreach makefile,$(call at.path,$(addsuffix /Makefile,$(at.subdirs/$(outdir)) $(at.depdirs/$(outdir)))),\ + $(eval include $(filter-out $(_at.included_makefiles),$(makefile))))) + +# This bit only gets evaluated once, after all of the other Makefiles are read +ifeq ($(_at.NO_ONCE),) + +outdir = /bogus +srcdir = /bogus + +$(foreach v,$(at.dirlocal),$(eval $v=)) + +include $(call _at.reverse,$(sort $(wildcard $(topsrcdir)/build-aux/Makefile.once.tail/*.mk))) + +endif # _at.NO_ONCE diff --git a/build-aux/write-ifchanged b/build-aux/write-ifchanged new file mode 100755 index 0000000..185ceb0 --- /dev/null +++ b/build-aux/write-ifchanged @@ -0,0 +1,25 @@ +#!/usr/bin/env bash +# Copyright (C) 2015 Luke Shumaker +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. + +outfile=$1 +tmpfile="$(dirname "$outfile")/.tmp${outfile##*/}" + +cat > "$tmpfile" || exit $? +if cmp -s "$tmpfile" "$outfile"; then + rm -f "$tmpfile" || : +else + mv -f "$tmpfile" "$outfile" +fi diff --git a/config.mk.in b/config.mk.in new file mode 100644 index 0000000..ffe7c1c --- /dev/null +++ b/config.mk.in @@ -0,0 +1,114 @@ +# This file is based on ยง7.2 "Makefile Conventions" of the release of +# the GNU Coding Standards dated April 13, 2016. + +dist.pkgname = @PACKAGE_TARNAME@ +gnu.pkgname = @PACKAGE_NAME@ + +# AC_PROG_{AWK,GREP,EGREP,FGREP,INSTALL,MKDIR_P,SED} +# 7.2.2: Utilities in Makefiles +# ----------------------------- + +# It's ok to hard-code these commands in rules, but who wants to +# memorize the list of what's ok? +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@ +BISON = bison +CC = @CC@ +FLEX = flex +INSTALL = @INSTALL@ +LD = ld +LDCONFIG = ldconfig +LEX = @LEX@ +MAKEINFO = makeinfo +RANLIB = @RANLIB@ +TEXI2DVI = texi2dvi +YACC = @YACC@ + +# 7.2.3 Variables for Specifying Commands +# --------------------------------------- + +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_DATA = @INSTALL_DATA@ + +STRIP = strip +TEXI2HTML = $(MAKEINFO) --html +TEXI2PDF = $(TEXI2DVI) --pdf +TEXI2PS = $(TEXI2DVI) --ps +MKDIR_P = @MKDIR_P@ + +# 7.2.5 Variables for Installation Directories +# -------------------------------------------- + +# Root for the installation +prefix = @prefix@ +exec_prefix = @exec_prefix@ +# Executable programs +bindir = @bindir@ +sbindir = @sbindir@ +libexecdir = @libexecdir@ +# Data files (Autoconf won't support runstatedir until version 2.70) +datarootdir = @datarootdir@ +datadir = @datadir@ +sysconfdir = @sysconfdir@ +sharedstatedir = @sharedstatedir@ +localstatedir = @localstatedir@ +runstatedir = $(localstatedir)/run +# Specific types of files +includedir = @includedir@ +oldincludedir = @oldincludedir@ +docdir = @docdir@ +infodir = @infodir@ +htmldir = @htmldir@ +dvidir = @dvidir@ +pdfdir = @pdfdir@ +psdir = @psdir@ +libdir = @libdir@ +lispdir = $(datarootdir)/emacs/site-lisp +localedir = @localedir@ + +mandir = @mandir@ +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 |