manual: improve explanation of target directory definition

Bring this more up to date by mentioning the dotfiles use case.
This commit is contained in:
Adam Spiers 2021-04-04 22:52:22 +01:00
parent 478c7b921d
commit 72140071ad
2 changed files with 8 additions and 3 deletions

2
NEWS
View file

@ -13,6 +13,8 @@ News file for Stow.
***** Added some more information from the web page to the README ***** Added some more information from the web page to the README
***** Made some small improvements to the documentation
***** Added a CONTRIBUTING.md file ***** Added a CONTRIBUTING.md file
***** Add a =watch= target to =Makefile= ***** Add a =watch= target to =Makefile=

View file

@ -220,9 +220,12 @@ to be installed in a particular directory structure --- e.g., with
@cindex target directory @cindex target directory
A @dfn{target directory} is the root of a tree in which one or more A @dfn{target directory} is the root of a tree in which one or more
packages wish to @emph{appear} to be installed. A common, but by no packages wish to @emph{appear} to be installed. @file{/usr/local} is a
means the only such location is @file{/usr/local}. The examples in this common choice for this, but by no means the only such location. Another
manual will use @file{/usr/local} as the target directory. common choice is @file{~} (i.e. the user's @code{$HOME} directory) in
the case where Stow is being used to manage the user's configuration
(``dotfiles'') and other files in their @code{$HOME}. The examples in
this manual will use @file{/usr/local} as the target directory.
@cindex stow directory @cindex stow directory
A @dfn{stow directory} is the root of a tree containing separate A @dfn{stow directory} is the root of a tree containing separate