aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index 11cda7f..434a98a 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,10 @@ smaller provided scripts for convenience's sake.
## bib-add
A script for inserting a new entry into a bibtex database file. It will
accept a fully formatted entry on standard input and add it to a database
-file presented as an argument.
+file presented as an argument. The database is never modified in place:
+the new version is built in a temporary file, verified, and only then
+swapped in, with the previous contents saved in db.bib.bak. Replacing an
+entry (-f) preserves every other byte of the file.
## bib-gen
A script which generates a bibtex entry based on input. By default it will
@@ -72,4 +75,5 @@ POSIX shell and awk only, with two exceptions: bib-fetch requires curl,
plus pdftotext (poppler) for DOI extraction from pdfs.
# Tests
- make test
+ make test # unit + integration suites
+ make fuzz # robustness fuzzing against bogus input