It was quite simple really, but really powerful to be able to tweak/replace a dataset hit make, and have a fully updated version of my thesis ready to go.
I quite like it !
texfiles = acronyms.tex analytical_mecs_procedure.tex analytical_mecs.tex \
anderson_old.tex background.tex chaincap.tex \
conclusions.tex cvici.tex gold_chain_test.tex introduction.tex \
main.tex mcci_manual.tex methods.tex moljunc.tex \
tb_sum_test.tex times_procedure.tex tm_mcci_workflow.tex tmo.tex \
vici_intro.tex
# dynamically generated figures
all: main.pdf
main.pdf: $(texfiles) figures/junction_occupations.pdf figures/overlaps_barplot.pdf \
figures/transmission_comparison.pdf \
figures/wigner_distributions.pdf
pdflatex main.tex && bibtex main && pdflatex main.tex && pdflatex main.tex
figures/junction_occupations.pdf: figures/junction_occupations.hs
ghc --make figures/junction_occupations.hs
figures/junction_occupations -w 800 -h 400 -o figures/junction_occupations.svg
inkscape -D -A figures/junction_occupations.pdf figures/junction_occupations.svg
figures/overlaps_barplot.pdf: figures/overlaps_barplot.py
python figures/overlaps_barplot.py
figures/transmission_comparison.pdf: figures/transmission_comparison.py
python figures/transmission_comparison.py
figures/wigner_distributions.pdf: figures/wigner_distributions.py
python figures/transmission_comparison.py
clean:
rm *.log *.aux *.blg *.bbl *.dvi main.pdf figures/%.pdf: figures/%.py
python $< texfiles = $(wildcard *.tex)
figures_ink = figures/junction_occupations.pdf
figures_py = figures/overlaps_barplot.pdf \
figures/transmission_comparison.pdf \
figures/wigner_distributions.pdf
figures = $(figures_ink) $(figures_py)
main.pdf: main.tex $(texfiles) $(figures)
pdflatex $<
bibtex $(<:*.tex=*)
pdflatex $<
pdflatex $<
figures/junction_occupations: %: %.hs
ghc --make $^
figures/junction_occupations.svg: figures/junction_occupations
$< -w 800 -h 400 -o $@
$(figures_ink): %.pdf: %.svg
inkscape -D -A $@ $^
$(figures_py): %.pdf: %.py
python $^
clean:
rm *.log *.aux *.blg *.bbl *.dvi main.pdfAll research should be like this. Explaining things in words is simply so imprecise you end up spending forever to show someone something that a program can tell you quickly.
"I used xyz transformation with abc parameters" can be gleaned easily from code.
My take on the same plan ( "make thesis" ):
It's not pretty, but it works. https://github.com/4kbt/PlateWash
Unblinding tweet: https://twitter.com/CharlieHagedorn/status/59565285891105177...
Finished product: https://digital.lib.washington.edu/researchworks/handle/1773...
All my analysis code, plots, etc were already in python, so it fit in well. Lyx has a CLI from where I exported .tex and compiled to pdf.
- make test : run the entire test suite on local environment
- make ci : run the whole test suite (using docker compose so this can easily be executed by any CI server without having to install anything other than docker and docker-compose) and generate code coverage report, use linter tools to check code standards
- make install-deps : installs dependencies for current project
- make update-deps : will check if there is a newer version of dependencies available and install it
- make fmt : formats the code (replace spaces for tabs or vice-versa, remove additional whitespaces from beginning/end of files etc)
- make build : would compile and build a binary for current platform, I would also defined platform specific sub commands like make build-linux or make build-windows
- make docker-build
- make docker-test
which are essentially wrappers around build/test, just in docker.
It's great for going back to a project you haven't touched in months/years and then typing "make" to build it regardless of the language or tool chain.
- make dev: stops, builds, and runs the code locally in a Docker container.
I personally achieve the same result with a homebrew solution that uses bash exclusively (https://github.com/zweicoder/magic) but just curious to know why so many people prefer makefiles.
And we run tests on 3 flavors of Hadoop (HDP, CDH, and IOP), each of which is broken down into a flavor-base image with most of the packages installed, and various other images derived from that, which means we have a dependency chain that looks like:
base-image -> base-image-with-java -> flavor-base => several other images.
Enter make, to make sure that all of these get rebuilt in the correct order and that at the end, you have a consistent set of images.
https://github.com/Teradata/docker-images
But wait, there's more. Docker LABEL information is contained in a layer. Our LABEL data currently includes the git hash of the repo. Which means any time you commit, the LABEL data on base-with-java changes, and invalidates everything downstream. This is terrible, because downloading the hadoop packages can take a while. So I have a WIP branch that builds the images from an unlabelled layer.
https://github.com/ebd2/docker-images/tree/from-unlabelled
As an added bonus, there's a graph target that automatically creates an image of the dependency graph of the images using graphviz.
Arguably, all of the above is a pretty serious misuse of both docker and make :-)
I can answer complaints about the sins I've committed with make, but the sins we've committed with Docker are (mostly) not my doing.
I did a makefile like
file1:
wget http://example.com/file1
file2:
wget http://example.com/file2
file3:
wget http://example.com/file3
And used make -j4 to download all of them, but only 4 parallel tasks at once. It starts another download when one finishesEven though Make does not have built-in support for arithmetic (as far as I know), it's possible to implement it by way of string manipulation.
I don't recommend ever doing this in production code, but it was a fun challenge!
I do wonder what the response would be like if I actually wrote something like this in a real job interview though...
Would the interviewer like my comment style? Would they be impressed that I have the technical skills needed to actually pull it off? Or, would they be so horrified by it that they'd refuse to ever let me touch any of their code? :)
http://www.oilshell.org/blog/ (Makefile not available)
and build a Python program into a single file (stripped-down Python interpreter + embedded bytecode):
https://github.com/oilshell/oil/blob/master/Makefile
Although generally I prefer shell to Make. I just use Make for the graph, while shell has most of the logic. Although honestly Make is pretty poor at specifying a build graph.
These reasons (and others) are why I gave up on make for bioinformatics processing and wrote a replacement. I'll release and publish it at some point.
1. Multiple targets for a single recipe:
file.a file.b file.c: dep.foo dep.bar
...
This says that the recipe makes all of file.a, file.b and file.c in one go.2. Make definitely doesn't randomly delete files. It deletes implicit targets.
Make by default knows how to build a lot of standard things like object files for c programs, yacc and bison stuff, etc. These are called implicit targets. These are considered intermediate files to be deleted. You can override the defaults or add your own implicit targets by using pattern matching like this:
%.foo: %.bar
...
If you want to use pattern matching for non-implicit targets so they don't get deleted, you can do that too: a.foo b.foo c.foo: %.foo: %.bar
...
The list before the first colon says which targets the pattern-matched rule applies to and shouldn't contain wildcards. These targets won't get deleted.3. This seems like a misunderstanding of make's basic role. Make just spawns shells when running a recipe; like bash, it shouldn't need to know how many threads you're using to run an arbitrary command. If you want make to build targets in parallel whenever possible, look at the `-j` option. If you want a certain build recipe to run multi-threaded, use the proper tool for the recipe.
4. Not sure what you mean by crash recovery, but considering the above, I'm pretty sure you might just be fighting make unnecessarily.
Honestly, try reading the info manual. It's kind of massive and daunting, but the intro material is really accessible, and taken in pieces, you can easily learn to become friends with this venerable tool.
2. If I create a rule to create an intermediate file "b" from original file "a", then another rule to create file "c" that I want to keep from "b", but there is an error running the command that creates "c", then make will happily delete the intermediate "b" (which in my case took 27 hours to create) although it knows the final "c" wasn't created properly. This means that when I rerun make (having fixed the problem), that 27 hour process needs to be run again, which is a waste of my time.
3. I want to say "make -j 64" on my 64-thread server, and not have 64 64-thread processes start. But I also do want 64 single-threaded processes to run when possible.
4. By crash recovery, I mean that by default a process will start creating the target file. If someone yanks the power, that target file will be present, with a recent modified time, but incomplete. Make will assume the file was created fine, so when I rerun make it will try to perform the next step, which may take 10 hours to fail. I want make to notice that the command did not successfully complete, and restart it from scratch.
As far as I know, most compilers are single-threaded, so this isn't much of an issue in practice. But I'm curious where you've encountered this problem.
https://www.gnu.org/software/make/manual/html_node/Special-T...
For #3, I think you may be misreading ps; on Linux, ps will show you threads as if they are processes when they are not.
For #3, no I think I know how to read ps. I don't want 64 64-thread processes running on my 64-thread server, because that is hell for an OS scheduler, and makes things run slower, not faster.
For #3, I didn't mean to come across as pedantic. I haven't encountered what you're describing, but I have personally been surprised by how Linux does process accounting, so I apologize; I just figured you were being bitten by the same thing.
I like make a lot, but I don't use it for everything, because sometimes there simply are better tools for the task, and I hope you were able to figure out a solution.
2. This is an interesting case. It's like the opposite of .DELETE_ON_ERROR.
Anyway, it seems like you have some legitimate workloads that make just doesn't fit well with. Mind sharing the solution you designed?
https://www.cmcrossroads.com/article/rules-multiple-outputs-...
All his criticisms are correct except maybe #3 which I don't understand.
Another problem I've found is that Make doesn't consider the absence of a prequisite to mean the target is out of date. So if foo.html depends on foo.intermediate, and then you delete foo.intermediate, then "make foo.html", foo.html will be considered up to date. I guess this is part of the odd feature where Make deletes intermediaries, but even if you have .SECONDARY on, which I do, it still behaves this way.
The bottom line is that it's extraordinarily easy to write incorrect Makefiles -- either underspecifying or overspecifying dependencies -- and it's very difficult to debug those problems. My Makefile is still full of bugs, so I "make clean" when something goes wrong.
One thing that would go a long way is if it had a shorthand for referring to the prequisites in commands, like $P1 $P2 $P3, and if it actually enforced that you use those in the command lines! I don't want to create variables for every single file, and when I rename files, rules can grow invisible bugs easily.
Some details here: http://www.oilshell.org/blog/2017/05/31.html
I would avoid learning make hodge-podge from StackOverflow as that will just frustrate you. If you take the info page in pieces and are a little methodical about it, you will probably end up liking make!
Happy make-ing!
Make is full of cases where the obvious thing is wrong. That is not a good UI!
As a conceptual summary, I would say that the problems stem from a couple underlying causes:
1) The execution model of Make is confused. It is sort of "functional" but sort of not. To debug it sometimes you have to "step through" the procedural logic of Make, rather than reasoning about inputs and outputs like a functional program. I mentioned this here [2].
2) You want to specify the correct build graph, and Make offers you virtually no help in doing so. An incorrect graph is when you underspecify or overspecify your dependencies. Underspecifying means you do "make clean" all the time because the build might be wrong. Overspecifying means your builds are slow because things rebuild that shouldn't rebuild.
In practice, Makefiles are full bugs like this. In fact I should have mentioned that my Oil makfile is FULL OF bugs. Making it truly correct is hard to express because some dependencies are dynamic (i.e. the gcc -M problem.) But I just "make clean" for now.
The Google build system Bazel [3] is very principled about these things, but I don't think it makes sense for most open source projects because it's pretty heavy and makes a lot of assumptions. It works well within Google though.
It does some simple things like check that your build action actually produces the things it said it would! Make does not do this! It can run build actions in a sandbox, to prevent them from using prerequisites that aren't declared. And it has better concepts of build variants, better caching, etc.
All these things are really helpful for specifying a correct build graph (and actually trivial to implement).
3) Another thing I thought of: Make works on timestamps of file system entries, but timestamps in Unix mean totally different things for files and directories! You can depend on a directory and that has no coherent meaning that I can think of. Conversely it's hard to depend on a directory tree of files whose names aren't known in advance.
4) Both Make and Bazel essentially assume the build graph is static, when it is often dynamic. (gcc -M again, but I also encountered it with Oil's Python dependencies) The "Shake" build system apparently does something clever here.
[1] https://www.cmcrossroads.com/article/rules-multiple-outputs-...
Turned out much simpler (if less feature full), much faster (it's finished in the time it takes node to start) and much more stable than other's I've used.
- Compilation of papers I am writing (in LaTeX). The Makefile processes the .tex and .bib files, and produces a final pdf. Fairly simple makefile
- Creation of initial conditions for galaxy merger simulations. This I obtained from a collaborator. We do idealized galaxy merger simulations and my collaborator has developed a scheme to create galaxies with multiple dynamical components (dark matter halos, stellar disks, stellar spheroids, etc.) very near equilibrium. We have makefiles that generate galaxy models, place those galaxies on initial orbits, and then numerically evolve the system.
tmux:
ln -s $(CURDIR)/.tmux.conf $(HOME)/.tmux.conf
tmux source-file ~/.tmux.conf
reload-tmux:
tmux source-file ~/.tmux.conf
gitconfig:
ln -s $(CURDIR)/.gitconfig $(HOME)/.gitconfig
cd ~/configs then make whatever. ~/configs itself is a git repository.Point being that autoconf is often overkill for smaller C projects.
We're doing it by calling a PLATFORM and using an IF statement in the makefile: make PLATFORM=HOST for example. The makefile then replaces the compiler variable, compiler flags, linker, flags, etc.
https://github.com/official-stockfish/Stockfish/blob/master/...
I use Makefile's regularly on open source and personal profiles (e.g. https://github.com/tony/tmuxp/blob/master/Makefile). Feel free to take and use that code, it's available under the BSD license.
The creativity comes in when dealing with cross-platform compatibility: Not all file listing commands are implemented the same. ls(1) doesn't work the same across all shell systems, and find on BSD accepts different arguments than GNU's find. So to collect a list of files to watch, we use POSIX find and store it in a Make variable.
Then, there's a need to get a cross platform file watcher. This is tricky since file events work differently across operating systems. So we bring in entr(1) (http://entrproject.org/). This works across Linux, BSD's and macOS and packaged across linux distros, ports, and homebrew.
Another random tip: For recursive Make calls, use $(MAKE). This will assure that non-GNU Make systems can work with your scripts. See here: https://github.com/liuxinyu95/AlgoXY/pull/16
File outputs were progress logs of the backups that got renamed after the backup, so if any jobs failed in the backup window, you could easily inspect them and rerun the failed jobs just by rerunning the make command.
Fun times. Handling filenames with spaces was an absolute pain, though.
A personal wiki and resource catalog. The only thing delivered is the makefile, which uses existing tools, and a small convenience script to run it.
https://snowplowanalytics.com/blog/2015/10/13/orchestrating-...
We gradually swapped them out in favour of our own DAG-runner written in Rust, called Factotum:
* a source code download,
* copying IDE project files not included in the source,
* creating a build folders for multiple builds (debug/release/converage/benchmark, clang & gcc),
* building and installing a specific branch,
* copying to a remote server for benchmark tests.The idea is if you want to use the library, you just include the makefile inside your project makefile, define a TARGET values and you will automatically have tasks for build, debug, etc.
The key is a hack on .SECONDEXPANSION pragma of GNU make, which means it's only work in GNU/Linux environment.
[1] https://GitHub.com/shuLhan/libvos
Edit: ah, turn out I write some documentation about it here: http://kilabit.info/projects/libvos/doc/index.html
It probably will require quite a few changes, but if the /proc file system exposed running processes by name, and contained a file for each port that something listened to, one _could_ run make on that 'directory' with a makefile that describes the dependencies between components of the system.
Useful? Unlikely, as the makefile would have to describe all hardware and their dependencies, and it is quite unlikely nowadays that that is even possible (although, come to think of it, a true hacker with too much time in hand and a bit of a masochistic tendencies could probably use autotools to creative use)
It has much of the same functionality, but I already know (and love) ruby, whereas make comes with its own syntax that isn't useful anywhere else.
You can easily create workflows, and get parallelism and caching of intermediate results for free. Even if you're not using ruby and/or rails, it's almost no work to still throw together the data model and use it for data administration as well (although the file-based semantics unfortunately do not extend to the database, something I've been meaning to try to implement).
Lately, I've been using it for machine learning data pipelines: spidering, image resizing, backups, data cleanup etc.
You could use both to accomplish the same thing, sure. But their concepts are quite different.
Rake works on tasks, which you define (or import from some gem).
Make works with file targets more than tasks. You define how it can make a certain (type of) file and it does the job.
Personally I mostly use Make if I want to generate files from something else. Otherwise I find small scripts easier than Rake or equivalent.
make is pretty neat if you think about it as a framework to help you compute/derive values from other values. each value happens to be stored in the filesystem as a file.
in contrast, many of the newer build-tool make replacements seem to miss the whole value of values and either push or force you in a direction of doing actions with side effects.
file 'blogpost.html' # we want to produce blogpost.html
# this rule specifies how to build
# any .html from the source
rule ".html" => ".md" do |t|
sh "pandoc -o #{t.name} #{t.source}"
endMakefile: https://github.com/openresty/openresty.org/blob/master/v2/Ma...
Well, I have "make encrypt" and "make decrypt" commands that will iterate over the files in an ".encrypted-files" file. Decrypt will also add a pre-commit hook that will reject any commit with a warning.
This is tons easier than trying to remember the ansible-vault commands, and I never have to worry about trying to remember how to permanently delete a commit from GitHub.
https://github.com/hortonworks/hive-testbench/blob/hive14/tp...
The shell script generates a Makefile and the Makefile runs the hadoop commands, so that the parallel dep handling is entirely handed off to Make.
This make it super easy to run 2 parallel workloads at all times - unlike xargs -P 2, this is much more friendly towards complex before/after deps and failure handling.
Using a Makefile allowed someone to quickly drop in new keys/certs and have all of the output formats built in a single command. Converting and packaging a single certificate requires one or more intermediate commands and Makefile is setup to directly handle this type of workflow.
I use one to build my company's Debian Vagrant boxes: https://app.vagrantup.com/koalephant
I use one to build a PHP library into a .phar archive and upload it to BitBucket
My static-ish site generator can create a self-updating Makefile: https://news.ycombinator.com/item?id=14836706
I use them as a standard part of most project setup
Instead of bloated autotools I also call a config.sh from make to fill some config.inc or config.h values, which even works fine for cross-compiling.
make seems to be easier to install/get running than the myriad of non packaged, github only projects i have found.
i am also currently using it with rsync to implement a poormans dropbox on a vps host with a systemd timer unit to clean files after 30 days for sharing files with customers, a simple wrapper script dumps it in the right folder, invokes make and causes rsync to run. the makefile also haandles setup of the account like ssh-add (with restricted commands), key generation and config options (via include files)
http://old.storytotell.org/blog/2009/07/13/how-to-manage-a-w...
It's pretty cool, but not ideal.
I'm building a static(ish) site generator, that features a built-in "configure" command to generate a makefile, so that only changed files and their dependents need to be rebuilt.
That's also part of why it's called a 'static-ish' site generator - it can render stuff into pure static html, but it can also use things like SSI or ESI to embed common things, so e.g. a nav bar/footer could be injected using SSI or ESI, and then when that changes, not every page needs to be re-built.
Edit: s/script/command/
See gopher://jdebp.info/1/Repository/freebsd/ under "how this site is built" and gopher://jdebp.info/1/Repository/debian/dists/ .
See also gopher://jdebp.info/h/Softwares/djbwares/guide/gopherd.html .