aboutsummaryrefslogtreecommitdiff
path: root/README-hacking.md
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2020-01-01 20:48:52 +0000
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2020-01-01 20:48:52 +0000
commit7cc80b3b9a2eebf5286a983df3ebaf3952ea6fca (patch)
treef4f01b4e3e7dc98d8cdc23aafbb08dd62d6805dc /README-hacking.md
parentea6bc6f08632056132ecfc2cb9a22101516b219c (diff)
Verification function checks if file exists
Until now, if the file to be verified didn't exist, a different checksum would be generated, and it would stop, but it wasn't immediately clear if the differing checksum is because the file doesn't exist at all! With this commit, before calculating the checksum, we first make sure if the file exists. If it doesn't exist an explicit error is printed and thus will help the project editor to find the cause of the problem.
Diffstat (limited to 'README-hacking.md')
-rw-r--r--README-hacking.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README-hacking.md b/README-hacking.md
index ec6bf4e..6cd6f46 100644
--- a/README-hacking.md
+++ b/README-hacking.md
@@ -810,11 +810,13 @@ Other basic customizations
`reproduce/analysis/make/verify.mk`. The verification of all the files
is only done in one recipe. First the files that go into the
plots/figures are checked, then the LaTeX macros. Validation of the
- former (inputs to plots/figures) should be done manually. You can see
- two examples of the dummy steps (with `delete-me`). For the latter,
- you just have to update the checksums. The important thing to consider
- is that a simple checksum can be problematic because some file
- generators print their run-time date in the file (for example as
+ former (inputs to plots/figures) should be done manually. If its the
+ first time you are doing this, you can see two examples of the dummy
+ steps (with `delete-me`, you can use them if you like). These two
+ examples should be removed before you can run the project. For the
+ latter, you just have to update the checksums. The important thing to
+ consider is that a simple checksum can be problematic because some
+ file generators print their run-time date in the file (for example as
commented lines in a text table). When checking text files, this
Makefile already has this function:
`verify-txt-no-comments-leading-space`. As the name suggests, it will