diff --git a/Makefile b/Makefile index 28e58f2be..ae03fe752 100644 --- a/Makefile +++ b/Makefile @@ -9,5 +9,7 @@ doc: .always cd doc && poki install: .always make -C c install +clean: .always + make -C c clean .always: @true diff --git a/doc/build.html b/doc/build.html index 6189dcf31..1667493c8 100644 --- a/doc/build.html +++ b/doc/build.html @@ -93,9 +93,21 @@ Miller commands were run with pretty-print-tabular output format.

To build: just run make in the c/ subdirectory of the repo. To install, run -make install after editing the install target in the -makefile to configure the destination. +href="https://github.com/johnkerl/miller">the repo. This builds the mlr executable as well as running +all unit and regression tests. + +

This default make target is also appropriate to run before a commit. + +

To install, run make install after editing the install +target in the makefile to configure the destination. (See https://github.com/johnkerl/miller/issues/9 +which will allow for a configure --install-dir=... option.) + +

If you are doing development of Miller, you can optionally run make +dev in the c/ subdirectory. This runs all the same regression +tests, but with the addition of two niceties: it also updates the tags +file (requires ctags), and runs the unit tests with valgrind +which can help illuminate memory issues.

C compiler: I normally use gcc: @@ -128,7 +140,8 @@ Alternatively, one may edit c/Makefile and change CCOMP=gcc to CCOMP=clang. (If you encounter issues I haven’t, please open an issue at https://github.com/johnkerl/miller.) -

External dependencies: +

Required external dependencies: These are necessary to produce the mlr +executable.

-As well, this documentation pageset is built using Poki: -docs here, -source code here. +

Optional external dependencies: +

Internal dependencies: These are included within the Miller source tree and do not diff --git a/doc/content-for-build.html b/doc/content-for-build.html index 74066d3bc..b23219806 100644 --- a/doc/content-for-build.html +++ b/doc/content-for-build.html @@ -1,7 +1,19 @@

To build: just run make in the c/ subdirectory of the repo. To install, run -make install after editing the install target in the -makefile to configure the destination. +href="https://github.com/johnkerl/miller">the repo. This builds the mlr executable as well as running +all unit and regression tests. + +

This default make target is also appropriate to run before a commit. + +

To install, run make install after editing the install +target in the makefile to configure the destination. (See https://github.com/johnkerl/miller/issues/9 +which will allow for a configure --install-dir=... option.) + +

If you are doing development of Miller, you can optionally run make +dev in the c/ subdirectory. This runs all the same regression +tests, but with the addition of two niceties: it also updates the tags +file (requires ctags), and runs the unit tests with valgrind +which can help illuminate memory issues.

C compiler: I normally use gcc: @@ -22,7 +34,8 @@ Alternatively, one may edit c/Makefile and change CCOMP=gcc to CCOMP=clang. (If you encounter issues I haven’t, please open an issue at https://github.com/johnkerl/miller.) -

External dependencies: +

Required external dependencies: These are necessary to produce the mlr +executable.

-As well, this documentation pageset is built using Poki: -docs here, -source code here. +

Optional external dependencies: +

Internal dependencies: These are included within the Miller source tree and do not