From def1bda9ff780dd333b45f882c5ebe057d78120c Mon Sep 17 00:00:00 2001 From: Casey Rodarmor Date: Sun, 19 Nov 2017 23:16:55 -0800 Subject: [PATCH] Miscellaneous cleanup (#261) --- .gitignore | 1 + CHANGELOG.md | 6 ++++-- FAQ.md | 34 ---------------------------------- README.asc | 34 ++++++++++++++++++++++++++++++++++ justfile | 2 ++ notes | 2 -- tmp/.gitignore | 2 -- 7 files changed, 41 insertions(+), 40 deletions(-) delete mode 100644 FAQ.md delete mode 100644 notes delete mode 100644 tmp/.gitignore diff --git a/.gitignore b/.gitignore index bfe19c8..e21d8f1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ /target /.vagrant /README.html +/tmp diff --git a/CHANGELOG.md b/CHANGELOG.md index de5e6d8..bb33b23 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ## [Unreleased] +- Do not evaluate backticks in assignments during dry runs (#253) + ## [0.3.1] - 2017-10-06 ### Added -- Started keeping a changelog in CHANGELOG.md -- Recipes whose names begin with an underscore will not appear in `--list` or `--summary` +- Started keeping a changelog in CHANGELOG.md (#220) +- Recipes whose names begin with an underscore will not appear in `--list` or `--summary` (#229) diff --git a/FAQ.md b/FAQ.md deleted file mode 100644 index f4608e4..0000000 --- a/FAQ.md +++ /dev/null @@ -1,34 +0,0 @@ -Frequently Asked Questions -========================== - -### What are the idiosyncrasies of make that just avoids? - -Make has some behaviors which are either confusing, complicated, or make it unsuitable for use as a general command runner. - -One example is that sometimes make won't run the commands in a recipe. For example, if you have a file called `test` and the the following makefile that runs it: - -```make -test: - ./test -``` - -Make will actually refuse to run it: - -```sh -$ make test -make: `test' is up to date. -``` - -Make see the recipe `test` and assumes that it produces a file called `test`. It then sees that this file exists and thus assumes that the recipe doesn't need to be run. - -To be fair, this behavior is desirable when using make as a build system, but not when using it as a command runner. - -Some other examples include having to understand the difference between `=` and `:=` assignment, the confusing error messages that can be produced if you mess up your makefile, having to use `$$` to write recipes that use environment variables, and incompatibilites between different flavors of make. - -### What's the relationship between just and cargo build scripts? - -[Cargo build scripts](http://doc.crates.io/build-script.html) have a pretty specific use, which is to control how cargo builds your rust project. This might include adding flags to `rustc` invocations, building an external dependency, or running some kind of codegen step. - -`just`, on the other hand, is for all the other miscellaneous commands you might run as part of development. Things like running tests in different configurations, linting your code, pushing build artifacts to a server, removing temporary files, and the like. - -Also, although `just` is written in rust, it can be used regardless of the language or build system your project uses. diff --git a/README.asc b/README.asc index 9eb0c5a..61a7ac9 100644 --- a/README.asc +++ b/README.asc @@ -515,6 +515,40 @@ $ just foo/build $ just foo/ ``` +== Frequently Asked Questions + +=== What are the idiosyncrasies of make that just avoids? + +Make has some behaviors which are either confusing, complicated, or make it unsuitable for use as a general command runner. + +One example is that sometimes make won't run the commands in a recipe. For example, if you have a file called `test` and the the following makefile that runs it: + +```make +test: + ./test +``` + +Make will actually refuse to run it: + +```sh +$ make test +make: `test' is up to date. +``` + +Make sees the recipe `test` and assumes that it produces a file called `test`. It then sees that this file exists and thus assumes that the recipe doesn't need to be run. + +To be fair, this behavior is desirable when using make as a build system, but not when using it as a command runner. + +Some other examples include having to understand the difference between `=` and `:=` assignment, the confusing error messages that can be produced if you mess up your makefile, having to use `$$` to write recipes that use environment variables, and incompatibilites between different flavors of make. + +=== What's the relationship between just and cargo build scripts? + +http://doc.crates.io/build-script.html[Cargo build scripts] have a pretty specific use, which is to control how cargo builds your rust project. This might include adding flags to `rustc` invocations, building an external dependency, or running some kind of codegen step. + +`just`, on the other hand, is for all the other miscellaneous commands you might run as part of development. Things like running tests in different configurations, linting your code, pushing build artifacts to a server, removing temporary files, and the like. + +Also, although `just` is written in rust, it can be used regardless of the language or build system your project uses. + == Miscellanea === Shell Alias diff --git a/justfile b/justfile index ff68d83..edc9a5f 100644 --- a/justfile +++ b/justfile @@ -90,12 +90,14 @@ test-quine: # make a quine, compile it, and verify it quine: + mkdir -p tmp @echo '{{quine-text}}' > tmp/gen0.c cc tmp/gen0.c -o tmp/gen0 ./tmp/gen0 > tmp/gen1.c cc tmp/gen1.c -o tmp/gen1 ./tmp/gen1 > tmp/gen2.c diff tmp/gen1.c tmp/gen2.c + rm -r tmp @echo 'It was a quine!' quine-text = ' diff --git a/notes b/notes deleted file mode 100644 index cffdfee..0000000 --- a/notes +++ /dev/null @@ -1,2 +0,0 @@ -todo -==== diff --git a/tmp/.gitignore b/tmp/.gitignore deleted file mode 100644 index d6b7ef3..0000000 --- a/tmp/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -* -!.gitignore