Update docs according to recent commits (#39)
Update docs according to recent commits
This commit is contained in:
commit
2eb3be13c5
3 changed files with 38 additions and 1 deletions
36
NEWS
36
NEWS
|
@ -36,6 +36,42 @@ News file for Stow.
|
||||||
|
|
||||||
** Convert README and INSTALL to Markdown
|
** Convert README and INSTALL to Markdown
|
||||||
|
|
||||||
|
** Update documentation to reflect more modern use cases
|
||||||
|
|
||||||
|
The README.md, stow(8) man page, and info manual have been updated
|
||||||
|
to de-emphasise the package management use, since these days almost
|
||||||
|
everyone prefers to use modern package managers such as rpm / dpkg
|
||||||
|
/ Nix for (system-wide) package management.
|
||||||
|
|
||||||
|
To compensate, more popular modern use cases for Stow have been
|
||||||
|
added, such as management of dotfiles and software compiled in the
|
||||||
|
user's $HOME directory.
|
||||||
|
|
||||||
|
** Stow now has a non-zero exit code if option parsing failed
|
||||||
|
|
||||||
|
Thanks to Brice Waegeneire for reporting this.
|
||||||
|
|
||||||
|
** chkstow now honours the $STOW_DIR environment variable
|
||||||
|
|
||||||
|
The stow script already honoured the $STOW_DIR environment
|
||||||
|
variable. Now chkstow does too, for consistency.
|
||||||
|
|
||||||
|
** Miscellaneous documentation fixes
|
||||||
|
|
||||||
|
- Various typos were fixed.
|
||||||
|
|
||||||
|
- The documentation for --verbose was updated to indicate that
|
||||||
|
verbosity levels now go up to 5.
|
||||||
|
|
||||||
|
- Erroneous glob examples in the --ignore documentation were fixed.
|
||||||
|
|
||||||
|
- The abbreviation "regex" was removed from the info manual for
|
||||||
|
consistency.
|
||||||
|
|
||||||
|
- INSTALL.md now also documents how to build directly from git.
|
||||||
|
|
||||||
|
** aclocal.m4 was updated using aclocal 1.15.1.
|
||||||
|
|
||||||
** Add Docker files for convenient testing across multiple Perl versions
|
** Add Docker files for convenient testing across multiple Perl versions
|
||||||
|
|
||||||
This is the first release which has been tested across 5 different
|
This is the first release which has been tested across 5 different
|
||||||
|
|
1
THANKS
1
THANKS
|
@ -32,6 +32,7 @@ Hongyi Zhao
|
||||||
Jean Louis
|
Jean Louis
|
||||||
Daniel Shahaf
|
Daniel Shahaf
|
||||||
Matan Nassau
|
Matan Nassau
|
||||||
|
Brice Waegeneire
|
||||||
|
|
||||||
Email addresses of new contributors are no longer being added by default
|
Email addresses of new contributors are no longer being added by default
|
||||||
for privacy reasons; however please contact the maintainer if you are
|
for privacy reasons; however please contact the maintainer if you are
|
||||||
|
|
|
@ -403,7 +403,7 @@ Do not perform any operations that modify the file system; in combination with
|
||||||
@item -v
|
@item -v
|
||||||
@itemx --verbose[=@var{n}]
|
@itemx --verbose[=@var{n}]
|
||||||
Send verbose output to standard error describing what Stow is
|
Send verbose output to standard error describing what Stow is
|
||||||
doing. Verbosity levels are 0, 1, 2, and 3; 0 is the default. Using
|
doing. Verbosity levels are from 0 to 5; 0 is the default. Using
|
||||||
@option{-v} or @option{--verbose} increases the verbosity by one; using
|
@option{-v} or @option{--verbose} increases the verbosity by one; using
|
||||||
@samp{--verbose=@var{n}} sets it to @var{n}.
|
@samp{--verbose=@var{n}} sets it to @var{n}.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue