git @ Cat's Eye Technologies shelf / b40ff1c
Document the two environment variables. Chris Pressey 4 years ago
1 changed file(s) with 9 addition(s) and 4 deletion(s). Raw diff Collapse all Expand all
7676
7777 * `SHELF_VERBOSE`
7878
79 TODO document this
79 If this environment variable is set to any non-empty value, the `shelf_*`
80 functions will produce verbose messages on standard output about what they
81 are doing, which can be useful for troubleshooting.
82
83 * `SHELF_DRYRUN`
8084
81 * `SHELF_LINK`
82
83 TODO document this
85 If this environment variable is set to any non-empty value, the `shelf_*`
86 functions will not make significant changes to the state of the
87 filesystem (for example, running commands like `ln` and `rm`) and instead
88 will only report that such changes would be made.