diff options
| author | Mohammad Akhlaghi <mohammad@akhlaghi.org> | 2020-01-18 00:44:05 +0000 |
|---|---|---|
| committer | Mohammad Akhlaghi <mohammad@akhlaghi.org> | 2020-01-18 00:44:05 +0000 |
| commit | 0774aac6c562b37800e49767ec28826ca8330d8c (patch) | |
| tree | faf876fac610e42765577102e0aec4e73a79cbc8 | |
| parent | 5781173d071314104ed2e3651b1222b385b0d798 (diff) | |
README-hacking.md: edits and corrections for easier customization
The checklist descriptions were slightly edited to be more clear. Also,
while following them, I noticed that while removing the "delete-me" parts
on `verify.mk', would cause an error: the `if [ $$m == delete-me ];'
statement we were saying to delete cause an error because `elif' was the
first statement Bash would see. So with this commit, the `download'
conditional (which isn't instructed to be deleted) was set to be the top
(with an `if') and the `delete-me' conditional now has an `elif'.
| -rw-r--r-- | README-hacking.md | 18 | ||||
| -rw-r--r-- | reproduce/analysis/make/verify.mk | 4 |
2 files changed, 12 insertions, 10 deletions
diff --git a/README-hacking.md b/README-hacking.md index a0a21d2..241f2dc 100644 --- a/README-hacking.md +++ b/README-hacking.md @@ -551,6 +551,7 @@ First custom commit $ git remote rename origin template-origin # Rename current/only remote to "template-origin". $ git branch -m template # Rename current/only branch to "template". $ git checkout -b master # Create and enter new "master" branch. + $ pwd # Just to confirm where you are. ``` - **Prepare to build project**: The `./project configure` command of the @@ -559,13 +560,13 @@ First custom commit will be touched. But since it takes long, it is useful to see what it is building at every instant (its almost impossible to tell from the torrent of commands that are produced!). So open another terminal on - your desktop and navigate to the same directory you just clone - above. Then run the following command. Before running the `./project - configure` command, this command will just print the date, once every - second. But as soon as it starts building software, you'll see names - of software come while they are being built, and go once they are - installed in the project build directory. See the "Inspecting status" - section below for more. + your desktop and navigate to the same project directory that you + cloned (output of last command above). Then run the following + command. It will just print the date, once every second. But as soon + as the next step starts building software, you'll see the names of + software come while they are being built, and go once they are + installed in the project build directory (again: don't worry, nothing + will be installed outside the build directory). ```shell $ while true; do echo; date; ls .build/software/build-tmp; sleep 1; done @@ -645,7 +646,8 @@ First custom commit - `reproduce/analysis/make/top-make.mk`: Delete the `delete-me` line in the `makesrc` definition. Just make sure there is no empty line - between the `download \` and `verify \` lines. + between the `download \` and `verify \` lines (they should be + directly under eachother). - `reproduce/analysis/make/verify.mk`: In the final recipe, under the commented line `Verify TeX macros`, remove the full line that diff --git a/reproduce/analysis/make/verify.mk b/reproduce/analysis/make/verify.mk index 1173f2c..a4afd45 100644 --- a/reproduce/analysis/make/verify.mk +++ b/reproduce/analysis/make/verify.mk @@ -114,8 +114,8 @@ $(mtexdir)/verify.tex: $(foreach s, $(verify-dep), $(mtexdir)/$(s).tex) # Verify TeX macros (the values that go into the PDF text). for m in $(verify-check); do file=$(mtexdir)/$$m.tex - if [ $$m == delete-me ]; then s=711e2f7fa1f16ecbeeb3df6bcb4ec705 - elif [ $$m == download ]; then s=6749e17ce606d57d30cebdbc1a5d23ad + if [ $$m == download ]; then s=6749e17ce606d57d30cebdbc1a5d23ad + elif [ $$m == delete-me ]; then s=711e2f7fa1f16ecbeeb3df6bcb4ec705 else echo; echo "'$$m' not recognized."; exit 1 fi $(call verify-txt-no-comments-leading-space, $$file, $$s) |