]> Cypherpunks.ru repositories - goredo.git/blobdiff - README
Removed hashless mode, small bugfixes, tai64nlocal
[goredo.git] / README
diff --git a/README b/README
index 022ae2004815a88d490d6e6af0c3e777a6b20e2e..edb5b765d22067201af5746fd5155bf049fe4bbc 100644 (file)
--- a/README
+++ b/README
@@ -37,35 +37,34 @@ NOTES                                                     *goredo-notes*
 
 FEATURES                                               *goredo-features*
 
-* explicit check that stdout and $3 are not written simultaneously
-* explicit check (similar to apenwarr/redo's one) that generated target
-  was not modified "externally" outside the redo, preventing its
-  overwriting, but continuing the build
+* explicit useful and convenient checks from apenwarr/redo:
+    * check that $1 was not touched during .do execution
+    * check that stdout and $3 are not written simultaneously
+    * check that generated target was not modified "externally" outside
+      the redo, preventing its overwriting, but continuing the build
 * targets, dependency information and their directories are explicitly
   synced (can be disabled, should work faster)
-* file's change is detected by comparing its ctime and, if it differs,
-  its BLAKE2b hash. Hash checking is done to prevent false positives
-  (can be disabled, will work faster)
+* file's change is detected by comparing its ctime and BLAKE2b hash
 * files creation is umask-friendly (unlike mkstemp() used in redo-c)
+* parallel build with jobs limit, optionally in infinite mode
 * coloured messages (can be disabled)
 * verbose debug messages, including out-of-date determination, PIDs,
-  lock acquirings/releases
-* parallel build with jobs limit, optionally in infinite mode
-* optional display of each target's execution time
+  lock and jobserver acquirings/releases
+* displaying of each target's execution time
 * each target's stderr can be displayed with the PID
 * target's stderr can be stored on the disk with TAI64N timestamp
-  prefixes for each line (you can use tai64nlocal utility from
-  daemontools (http://cr.yp.to/daemontools/tai64nlocal.html) to convert
-  them to local time). Captures can be viewed any time later
-
+  prefixes for each line. To convert them to localtime you can use either
+  tai64nlocal utility from daemontools (http://cr.yp.to/daemontools.html)
+  or make a symlink, to use built-in slower decoder: >
+    $ ln -s goredo tai64nlocal
+<
 COMMANDS                                               *goredo-commands*
 
 * redo-ifchange, redo-ifcreate, redo-always (useful with redo-stamp)
 * redo -- same as redo-ifchange, but forcefully and *sequentially* run
   specified targets
 * redo-log -- display TAI64N timestamped last stderr of the target
-* redo-stamp -- record stamp dependency and consider it non out-of-date
-  if stamp equals to the previous one
+* redo-stamp -- record stamp dependency. Nothing more, just dummy
 * redo-cleanup -- removes either temporary, or log files, or
   everything related to goredo
 * redo-whichdo -- .do search paths for specified target (similar to