Commit graph

95 commits

Author SHA1 Message Date
Adam Spiers
9985de7c78 HOWTO-RELEASE: THANKS is no longer being updated 2024-04-07 18:34:35 +01:00
Adam Spiers
238346f134 manual: clarify the pros and cons and history of --compat 2024-04-05 22:28:40 +01:00
Adam Spiers
8a17d8b4f2 manual: use American punctuation of "vs."
GNU and Stow are both originally from the USA, so it makes sense
to stay consistent with American English.
2024-04-01 22:39:32 +01:00
Adam Spiers
e8c46cf058 manual: disambiguate meaning of "source" 2024-03-31 23:20:22 +01:00
Adam Spiers
373ef62e70 manual: clarify that installation image is pre-installation 2024-03-31 23:20:22 +01:00
Adam Spiers
11d4ff01d7 manual: avoid double spaces after "i.e." 2024-03-31 15:25:35 +01:00
Adam Spiers
2791d00d06 manual: Expand the definition of symlinks and disambiguate "target"
Target can have two opposing meanings:

1. the target directory where symlinks are managed by Stow, and
2. the destinations of those symlinks

So try to move away from this by using the word "destination" for
symlinks.
2024-03-31 15:25:26 +01:00
Adam Spiers
aa03922520 manual: fix duplicated "of" typo 2024-03-09 17:57:04 +00:00
Adam Spiers
2c7d3d4762 manual: update the Reporting Bugs / Known Bugs sections 2024-03-09 17:56:48 +00:00
Adam Spiers
c30792270e manual: use @email{} for email addresses 2024-03-09 17:56:41 +00:00
Adam Spiers
72140071ad manual: improve explanation of target directory definition
Bring this more up to date by mentioning the dotfiles use case.
2024-03-09 17:56:14 +00:00
Adam Spiers
64e0dc8793 Beef up README.md and add CONTRIBUTING.md 2021-04-15 15:11:30 +01:00
Adam Spiers
205158a528 manual: request --verbose=5 for bug reports 2021-04-15 15:11:30 +01:00
Adam Spiers
3aae830e56 HOWTO-RELEASE: maintainer-clean is better than distclean 2021-04-15 15:11:30 +01:00
Adam Spiers
69614059a8 Ditch texinfo.tex from distribution 2021-04-15 15:11:29 +01:00
Christian Egli
74e0eab0c5 Mention the dotfiles option in the manual
This should have been part of 182acbbb64
when the option was first added.

This commit basically just copies the help text from stow.in into the
texinfo manual.
2020-05-27 17:51:37 +02:00
Adam Spiers
9fd3624a75 HOWTO-RELEASE: explicitly push to master
This avoids errors like

    fatal: You are pushing to remote 'savannah', which is not the upstream of
    your current branch 'master', without telling me what to push
    to update which remote branch.
2019-07-28 14:54:36 +01:00
Adam Spiers
c84a3b0f25 HOWTO-RELEASE: fix final step of bumping to next release version 2019-07-28 14:52:16 +01:00
Adam Spiers
71b9606ba4 HOWTO-RELEASE: explain how to confirm PAUSE acceptance of upload 2019-07-28 13:58:00 +01:00
Adam Spiers
7fae30ecce HOWTO-RELEASE: do ./Build dist earlier
docker builds break ./Build dist, so do it earlier.
2019-07-28 13:28:46 +01:00
Adam Spiers
5602166a57 Make sure release process starts from a clean slate 2019-07-28 13:15:11 +01:00
Adam Spiers
3aa30ae1aa fix cross-references under --no-folding section of manual
Under emacs, this was previously rendered as

    '--no-folding'

         This disables any further *note tree folding:: or *note tree
         refolding::.  If a new subdirectory is encountered whilst stowing a

which looks awkward.  Similarly under info(1):

    '--no-folding'

         This disables any further *note tree folding:: or *note tree
         refolding::.  If a new subdirectory is encountered whilst stowing a

The new way is undesirably repetitive, but at least grammatically
correct.  I don't think there's a better solution with texinfo :-/
2019-07-28 13:04:17 +01:00
Adam Spiers
ed2091e9a5 HOWTO-RELEASE: add suggested commands for updating home page 2019-07-28 13:04:17 +01:00
Adam Spiers
80d1472253 HOWTO-RELEASE: update news section of online home page 2019-07-16 19:24:19 +01:00
Adam Spiers
cfb3ff7eff HOWTO-RELEASE: update online docs *after* uploading release
It doesn't make sense to have docs online relating to a release which
isn't yet available; it's less confusing to have a small time window
in which the online docs are out of date.
2019-07-16 19:21:04 +01:00
Adam Spiers
4a9121eec9 Bump version to 2.3.1 for development of next release 2019-06-29 13:40:55 +01:00
Adam Spiers
94175829b9 Make NEWS export to text better
Run org-convert-to-odd-levels on NEWS and set local variables so
that sections can easily be exported for release announcements.
2019-06-29 01:30:33 +01:00
Adam Spiers
872ec96350 HOWTO-RELEASE: Fix cvs commit command for docs 2019-06-29 00:55:51 +01:00
Adam Spiers
cef930852c HOWTO-RELEASE: Fix git tag command 2019-06-29 00:36:00 +01:00
Adam Spiers
27796720d5 Upgrade to GPL v3 and add headers to files (#44)
Following advice from maintainers@gnu.org, bring Stow in line with
other GNU projects by upgrading it from GPL v2 to v3

  https://www.gnu.org/prep/maintain/html_node/Licensing-of-GNU-Packages.html#Licensing-of-GNU-Packages

as obtained in plain text and texinfo formats from

  https://www.gnu.org/licenses/

and adding appropriate headers:

  https://www.gnu.org/prep/maintain/html_node/License-Notices-for-Code.html#License-Notices-for-Code

Fixes #44: https://github.com/aspiers/stow/issues/44
2019-06-27 20:37:40 +01:00
Adam Spiers
c2a399985a remove trailing whitespace from lines 2019-06-27 13:54:36 +01:00
Adam Spiers
9c402559d2 Include the preamble in online versions of the manual
This is more inline with the suggestion in the texinfo manual:

https://www.gnu.org/software/texinfo/manual/texinfo/html_node/_0040top-Command.html

and also the preamble is useful in all cases.
2019-06-26 13:46:37 +01:00
Adam Spiers
b4cb6e775a Add Guillaume and myself to the list of @authors 2019-06-26 13:46:37 +01:00
Adam Spiers
e647c53af1 Add some polish to the release process 2019-06-25 20:05:47 +01:00
Charles LeDoux
dc42c34107 Add function to expand ~ in .stowrc files (#14)
Add a new expand_tilde() function that performs tilde expansion of
strings, and corresponding unit tests:

    * A ~ at the beginning of a path is expanded to the user's home
      directory.
    * Literal '~' can be provided with '\~'

Combine this with expand_environment() in a new expand_filepath()
function which applies all (both) required expansion functions to a
string, and use that in get_config_file_options() to expand .stowrc
options.

Add more tests to check that tilde expanded in correct places, i.e.:

    * expanded for --target and --dir
    * not expanded for --ignore, --defer, or --override

Update documentation on stowrc files according to this functionality
change.

Fixes #14: https://github.com/aspiers/stow/issues/14
2019-06-25 19:38:43 +01:00
Adam Spiers
c3cbdeb812 Synchronise --verbose documentation
The man page was updated with regard to higher --verbose levels but
not the info manual, so fix that.
2019-06-25 17:41:17 +01:00
Adam Spiers
72ef83cebd Fix old descriptions of Stow (#22)
De-emphasise the package management aspects, since these days
almost everyone prefers to use modern package managers such as
rpm / dpkg / Nix for (system-wide) package management.

Also include more popular modern use cases for Stow such as management
of dotfiles and software compiled in the user's $HOME directory.

Fixes #22: https://github.com/aspiers/stow/issues/22
2019-06-25 16:52:33 +01:00
Adam Spiers
dd42b09a5b avoid "regex" abbreviation for consistency 2018-02-11 17:55:40 +00:00
Adam Spiers
c84de4eb14 fix erroneous glob examples in --ignore documentation
Many thanks to Daniel Shahaf for noticing this.

http://lists.gnu.org/archive/html/bug-stow/2017-07/msg00000.html
2018-02-11 17:55:31 +00:00
Adam Spiers
e7e6c7fbde update the introductory text to clarify Stow's common usage
Thanks to Jean Louis for some suggestions on this.
2018-02-11 11:47:39 +00:00
Adam Spiers
ea11f266a5 fix typo in "Deleting Packages" chapter
Thanks to Hongyi Zhao for spotting this error and reporting it.
2017-03-04 14:29:06 +00:00
Adam Spiers
b160a1c807 clarify that ~/.stowrc args don't get processed by a shell
Address confusion reported here:

  http://lists.gnu.org/archive/html/bug-stow/2016-08/msg00000.html
2016-12-18 23:17:19 +00:00
Adam Spiers
5a8d275c47 replace a "you" typo with better text
The contents are prepended to the arguments; they still come after the
stow executable.
2016-12-18 23:14:39 +00:00
Adam Spiers
fd10706ce3 HOWTO-RELEASE: use Docker to test before releasing
Charles LeDoux did some awesome work providing this Docker environment
which can test across multiple Perl versions using perlbrew, so it
would be crazy not to use it.
2016-11-20 22:57:39 +00:00
Adam Spiers
98a8f7e3e7 use PAUSE upload for final validation step of release 2016-11-20 22:50:22 +00:00
Adam Spiers
a9f79c6a5b make sure release tags are also pushed to GitHub 2016-11-20 22:50:22 +00:00
Adam Spiers
17bbfb05c6 further refine the release process
Let's try a new approach where we increment the version number
immediately after publishing a release, not just before.

This will mean that anyone who builds from git gets a version of Stow
which is higher than the release which was just cut, and this could
provide valuable debugging hints in case a bug report does not clearly
state whether the problem arose with the latest release or with a build
from git.
2016-11-20 22:50:22 +00:00
Adam Spiers
08bff6df00 whitespace cleanups 2016-11-20 22:20:46 +00:00
Adam Spiers
0bc06e58e1 HOWTO-RELEASE: add a reminder to update THANKS
Make sure the maintainer always gives credit to contributors :-)
2016-11-20 22:07:47 +00:00
Adam Spiers
d82b6aa1a8 HOWTO-RELEASE: remove body indent 2015-11-09 11:05:20 +00:00