From 99b4cb6ba8bbf08f07304baa8fabca1b8f7d5c2c Mon Sep 17 00:00:00 2001 From: John Kerl Date: Tue, 23 Mar 2021 22:58:31 -0400 Subject: [PATCH] Update manpage-build procedure --- docs/Makefile | 9 --------- docs/build.rst | 4 ++-- docs/build.rst.in | 4 ++-- docs/cookbook.rst | 2 +- docs/data-examples.rst | 2 +- docs/data-sharing.rst | 32 ++++++++++++++++---------------- docs/reference-dsl.rst | 2 +- docs/reference-verbs.rst | 4 ++-- man/Makefile.am | 3 +++ 9 files changed, 28 insertions(+), 34 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index ffa8876ff..f0063fb6e 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -23,12 +23,3 @@ help: %: Makefile ./genrst @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -# These targets are only for local dev work. -install: - mkdir -p $(INSTALLDIR) - cp mlr.1 $(INSTALLDIR)/mlr.1 -installhome: - mkdir -p $(INSTALLHOME) - cp mlr.1 $(INSTALLHOME)/mlr.1 - diff --git a/docs/build.rst b/docs/build.rst index 1d44bac91..bd14db1eb 100644 --- a/docs/build.rst +++ b/docs/build.rst @@ -149,8 +149,8 @@ In this example I am using version 3.4.0; of course that will change for subsequ * Update version found in ``mlr --version`` and ``man mlr``: * Edit ``configure.ac``, ``c/mlrvers.h``, and ``miller.spec`` from ``3.3.2-dev`` to ``3.4.0``. Likewise ``docs/conf.py``. - * Do a fresh ``autoreconf -fiv`` and commit the output. - * ``make -C c -f Makefile.no-autoconfig installhome && make -C doc -f Makefile.no-autoconfig all installhome`` + * 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`` * Commit and push. * ISP upload so http://johnkerl.org/miller/doc/index.html will have updated head-docs. diff --git a/docs/build.rst.in b/docs/build.rst.in index 96565a536..981edfc15 100644 --- a/docs/build.rst.in +++ b/docs/build.rst.in @@ -146,8 +146,8 @@ In this example I am using version 3.4.0; of course that will change for subsequ * Update version found in ``mlr --version`` and ``man mlr``: * Edit ``configure.ac``, ``c/mlrvers.h``, and ``miller.spec`` from ``3.3.2-dev`` to ``3.4.0``. Likewise ``docs/conf.py``. - * Do a fresh ``autoreconf -fiv`` and commit the output. - * ``make -C c -f Makefile.no-autoconfig installhome && make -C doc -f Makefile.no-autoconfig all installhome`` + * 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`` * Commit and push. * ISP upload so http://johnkerl.org/miller/doc/index.html will have updated head-docs. diff --git a/docs/cookbook.rst b/docs/cookbook.rst index 6ae8e786b..937949fab 100644 --- a/docs/cookbook.rst +++ b/docs/cookbook.rst @@ -532,7 +532,7 @@ Suppose you have some date-stamped data which may (or may not) be missing entrie :: $ wc -l data/miss-date.csv - 1372 data/miss-date.csv + 1372 data/miss-date.csv Since there are 1372 lines in the data file, some automation is called for. To find the missing dates, you can convert the dates to seconds since the epoch using ``strptime``, then compute adjacent differences (the ``cat -n`` simply inserts record-counters): diff --git a/docs/data-examples.rst b/docs/data-examples.rst index 70d404c59..2fca5f772 100644 --- a/docs/data-examples.rst +++ b/docs/data-examples.rst @@ -96,7 +96,7 @@ Peek at the data: :: $ wc -l data/colored-shapes.dkvp - 10078 data/colored-shapes.dkvp + 10078 data/colored-shapes.dkvp $ head -n 6 data/colored-shapes.dkvp | mlr --opprint cat color shape flag i u v w x diff --git a/docs/data-sharing.rst b/docs/data-sharing.rst index 920cbfaf3..7bcfd32ae 100644 --- a/docs/data-sharing.rst +++ b/docs/data-sharing.rst @@ -117,23 +117,23 @@ Run as-is: :: $ python polyglot-dkvp-io/example.py < data/small - a=pan,b=pan,i=1,y=0.726802862743,ab=panpan,iy=1.72680286274,ta=str,tb=str,ti=int,ty=float,tab=str,tiy=float - a=eks,b=pan,i=2,y=0.522151108333,ab=ekspan,iy=2.52215110833,ta=str,tb=str,ti=int,ty=float,tab=str,tiy=float - a=wye,b=wye,i=3,y=0.338318525517,ab=wyewye,iy=3.33831852552,ta=str,tb=str,ti=int,ty=float,tab=str,tiy=float - a=eks,b=wye,i=4,y=0.134188743284,ab=ekswye,iy=4.13418874328,ta=str,tb=str,ti=int,ty=float,tab=str,tiy=float - a=wye,b=pan,i=5,y=0.863624469903,ab=wyepan,iy=5.8636244699,ta=str,tb=str,ti=int,ty=float,tab=str,tiy=float + a=pan,b=pan,i=1,y=0.7268028627434533,ab=panpan,iy=1.7268028627434533,ta=str,tb=str,ti=int,ty=float,tab=str,tiy=float + a=eks,b=pan,i=2,y=0.5221511083334797,ab=ekspan,iy=2.5221511083334796,ta=str,tb=str,ti=int,ty=float,tab=str,tiy=float + a=wye,b=wye,i=3,y=0.33831852551664776,ab=wyewye,iy=3.3383185255166477,ta=str,tb=str,ti=int,ty=float,tab=str,tiy=float + a=eks,b=wye,i=4,y=0.13418874328430463,ab=ekswye,iy=4.134188743284304,ta=str,tb=str,ti=int,ty=float,tab=str,tiy=float + a=wye,b=pan,i=5,y=0.8636244699032729,ab=wyepan,iy=5.863624469903273,ta=str,tb=str,ti=int,ty=float,tab=str,tiy=float Run as-is, then pipe to Miller for pretty-printing: :: $ python polyglot-dkvp-io/example.py < data/small | mlr --opprint cat - a b i y ab iy ta tb ti ty tab tiy - pan pan 1 0.726802862743 panpan 1.72680286274 str str int float str float - eks pan 2 0.522151108333 ekspan 2.52215110833 str str int float str float - wye wye 3 0.338318525517 wyewye 3.33831852552 str str int float str float - eks wye 4 0.134188743284 ekswye 4.13418874328 str str int float str float - wye pan 5 0.863624469903 wyepan 5.8636244699 str str int float str float + a b i y ab iy ta tb ti ty tab tiy + pan pan 1 0.7268028627434533 panpan 1.7268028627434533 str str int float str float + eks pan 2 0.5221511083334797 ekspan 2.5221511083334796 str str int float str float + wye wye 3 0.33831852551664776 wyewye 3.3383185255166477 str str int float str float + eks wye 4 0.13418874328430463 ekswye 4.134188743284304 str str int float str float + wye pan 5 0.8636244699032729 wyepan 5.863624469903273 str str int float str float DKVP I/O in Ruby ---------------------------------------------------------------- @@ -287,11 +287,11 @@ The :ref:`reference-dsl-system` DSL function allows you to run a specific shell $ mlr --opprint put '$o = system("echo -n ".$a."| sha1sum")' data/small a b i x y o - pan pan 1 0.3467901443380824 0.7268028627434533 bd2bd8216b9cb4aa5a12daa6cfc98eef2ee20e56 - - eks pan 2 0.7586799647899636 0.5221511083334797 16191338e81a46c7d127f5c8899f5c92e3cd38e3 - - wye wye 3 0.20460330576630303 0.33831852551664776 14ba3c3e96a2474ab6dc7409ebf9d6b9cc3d84f0 - - eks wye 4 0.38139939387114097 0.13418874328430463 16191338e81a46c7d127f5c8899f5c92e3cd38e3 - - wye pan 5 0.5732889198020006 0.8636244699032729 14ba3c3e96a2474ab6dc7409ebf9d6b9cc3d84f0 - + pan pan 1 0.3467901443380824 0.7268028627434533 f29c748220331c273ef16d5115f6ecd799947f13 - + eks pan 2 0.7586799647899636 0.5221511083334797 456d988ecb3bf1b75f057fc6e9fe70db464e9388 - + wye wye 3 0.20460330576630303 0.33831852551664776 eab0de043d67f441c7fd1e335f0ca38708e6ebf7 - + eks wye 4 0.38139939387114097 0.13418874328430463 456d988ecb3bf1b75f057fc6e9fe70db464e9388 - + wye pan 5 0.5732889198020006 0.8636244699032729 eab0de043d67f441c7fd1e335f0ca38708e6ebf7 - Note that running a subprocess on every record takes a non-trivial amount of time. Comparing asking the system ``date`` command for the current time in nanoseconds versus computing it in process: diff --git a/docs/reference-dsl.rst b/docs/reference-dsl.rst index 9710c0764..8aa317df0 100644 --- a/docs/reference-dsl.rst +++ b/docs/reference-dsl.rst @@ -1422,7 +1422,7 @@ This produces heteregenous output which Miller, of course, has no problems with $ mlr put '$x > 0.0; $y = log10($x); $z = sqrt($y)' data/put-gating-example-1.dkvp x=-1,y=nan,z=nan - x=0,y=-inf,z=-nan + x=0,y=-inf,z=nan x=1,y=0.000000,z=0.000000 x=2,y=0.301030,z=0.548662 x=3,y=0.477121,z=0.690740 diff --git a/docs/reference-verbs.rst b/docs/reference-verbs.rst index f8b0fc779..d0984e3b4 100644 --- a/docs/reference-verbs.rst +++ b/docs/reference-verbs.rst @@ -3147,7 +3147,7 @@ There are two main ways to use ``mlr uniq``: the first way is with ``-g`` to spe :: $ wc -l data/colored-shapes.dkvp - 10078 data/colored-shapes.dkvp + 10078 data/colored-shapes.dkvp :: @@ -3289,7 +3289,7 @@ The second main way to use ``mlr uniq`` is without group-by columns, using ``-a` :: $ wc -l data/repeats.dkvp - 57 data/repeats.dkvp + 57 data/repeats.dkvp :: diff --git a/man/Makefile.am b/man/Makefile.am index 923eb3ab1..286213daf 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -4,5 +4,8 @@ man1_MANS= mlr.1 # This target is not for use at package install; only at package-creation time. # The mlr.1 file should be committed to source control. It uses the mlr # executable from the PATH variable. +# +# See also +# https://miller.readthedocs.io/en/latest/build.html#creating-a-new-release-for-developers manpage: ruby mkman.rb > mlr.1