From b6f3be69a16fde29ecefc0913ca4f54db9485b4f Mon Sep 17 00:00:00 2001 From: John Kerl Date: Wed, 31 Mar 2021 17:40:51 -0400 Subject: [PATCH] Makefile build-order comments --- docs/Makefile | 3 +++ docs/build.rst.in | 1 + go/todo.txt | 6 ++---- man/Makefile.no-autoconfig | 3 +++ 4 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index f0063fb6e..5641e5529 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,5 +1,8 @@ # Minimal makefile for Sphinx documentation # +# Note: run this after make in the ../c directory and make in the ../man directory +# since ../c/mlr is used to autogenerate ../man/manpage.txt which is used in this directory. +# See also https://miller.readthedocs.io/en/latest/build.html#creating-a-new-release-for-developers # You can set these variables from the command line, and also # from the environment for the first two. diff --git a/docs/build.rst.in b/docs/build.rst.in index 14236e65a..8117bc4ab 100644 --- a/docs/build.rst.in +++ b/docs/build.rst.in @@ -148,6 +148,7 @@ In this example I am using version 3.4.0; of course that will change for subsequ * Edit ``configure.ac``, ``c/mlrvers.h``, ``miller.spec``, and ``docs/conf.py`` from ``3.3.2-dev`` to ``3.4.0``. * Do a fresh ``autoreconf -fiv`` and commit the output. (Preferably on a Linux host, rather than MacOS, to reduce needless diffs in autogen build files.) * ``make -C c -f Makefile.no-autoconfig installhome && make -C man -f Makefile.no-autoconfig installhome && make -C docs -f Makefile.no-autoconfig html`` + * The ordering is important: the first build creates ``mlr``; the second runs ``mlr`` to create ``manpage.txt``; the third includes ``manpage.txt`` into one of its outputs. * Commit and push. * Create the release tarball and SRPM: diff --git a/go/todo.txt b/go/todo.txt index 64edc1ad7..07cf67697 100644 --- a/go/todo.txt +++ b/go/todo.txt @@ -2,12 +2,10 @@ TOP OF LIST: * manpage.txt fu w/ comments & automake -* #455 -- doc-neatens re ordering ! substr operate on runes + +* #455 -- doc-neatens re ordering d windows mrpl colors -- ? checking isatty also -- ? -* more doclinks: - https://www.ict4g.net/adolfo/notes/data-analysis/tools-to-manipulate-csv.html - https://www.ict4g.net/adolfo/notes/data-analysis/miller-quick-tutorial.html * more about HTTP logs in miller -- doc and encapsulate: mlr --icsv --implicit-csv-header --ifs space --oxtab --from elb-log put -q 'print $27' diff --git a/man/Makefile.no-autoconfig b/man/Makefile.no-autoconfig index 4c677dedb..4cc9911ee 100644 --- a/man/Makefile.no-autoconfig +++ b/man/Makefile.no-autoconfig @@ -1,4 +1,7 @@ # Respective MANPATH entries would include /usr/local/share/man or $HOME/man. +# This should be run after make in the ../c directory but before make in the ../docs directory, +# since ../c/mlr is used to autogenerate ./manpage.txt which is used in ../docs. +# See also https://miller.readthedocs.io/en/latest/build.html#creating-a-new-release-for-developers INSTALLDIR=/usr/local/share/man/man1 INSTALLHOME=$(HOME)/man/man1