doc/features.texi

   1 @node Features
   2 @unnumbered Features
   3
   4 Notable features that differentiate @command{goredo} from many other
   5 implementations.
   6
   7 @itemize
   8
   9 @item explicit useful and convenient checks from @command{apenwarr/redo}:
  10     @itemize
  11     @item check that @file{$1} was not touched during .do execution
  12     @item check that @file{stdout} and @file{$3} are not written simultaneously
  13     @item check that generated target was not modified "externally" outside
  14       the redo, preventing its overwriting, but continuing the build
  15       (optionally can stop)
  16     @end itemize
  17 @item recursive, indented and serialized logs display ability, with
  18     priority to the depth and bad return codes, like in @command{apenwarr/redo},
  19     thanks to @url{https://apenwarr.ca/log/20181106, apenwarr's article}
  20 @item all environment variables, working directory, command line
  21     arguments, start/finish times, duration, participated PIDs, return
  22     codes can be saved for later investigation
  23 @item targets, dependency information and their directories are explicitly
  24   synced (can be disabled, should work faster)
  25 @item file's change is detected by comparing its size, and
  26     @url{https://github.com/BLAKE3-team/BLAKE3, BLAKE3} hash. Also as an
  27     optimization, by default if file's @code{ctime} is same, then hash
  28     check is skipped. Optionally you can disable that behaviour, or even
  29     enable trust to file's @code{mtime}
  30 @item files creation is @code{umask}-friendly (unlike @code{mkstemp()}
  31     used in @command{redo-c})
  32 @item parallel build with jobs limit, optionally in infinite mode
  33 @item optional coloured messages
  34 @item verbose debug messages, including out-of-date determination, PIDs,
  35   lock and jobserver acquirings/releases
  36 @item displaying of each target's execution time
  37 @item each target's @file{stderr} can be prefixed with the PID
  38 @item optional statusline with currently running/waiting/done jobs
  39 @item target's @file{stderr} can be stored on the disk with
  40     @url{http://cr.yp.to/libtai/tai64.html, TAI64N} timestamp prefixes
  41     for each line. To convert them to localtime you can use either
  42     @command{tai64nlocal} utility from
  43     @url{http://cr.yp.to/daemontools.html, daemontools}, or similar one:
  44     @code{go get go.cypherpunks.ru/tai64n/cmd/tai64nlocal}
  45 @item Either GNU Make or bmake @ref{Jobserver, jobserver} compatibility support
  46
  47 @end itemize