Ignore split page version of HTML manual.
[gnu-stow.git] / NEWS
blob7224ce4031cce39ec7bf88dbc16231caac7e7df4
1 News file for Stow.
3 * Changes in version 2.1.0
4 ** Major refactoring of code into separate Stow and Stow::Util Perl modules.
5 ** Added support for ignore list files.
6 ** Added support for CPAN-style installation and distribution via Module::Build.
7 ** Introduced `make test' target and significantly tightened up test suite.
8 ** Very large number of code and documentation fixes (over 80 commits since version 2.0.1).
9 ** The '--conflicts' option has been removed.
11 Stow will always show conflicts if they are found during the scanning
12 phase.
14 ** Improved debugging output.
15 ** Converted man page to POD format.
16 ** Fixed code style consistency issues.
17 ** Running configure from outside the source tree now works.
18 ** `make distcheck' now works.
19 * Changes in version 2.0.1
20 ** Defer operations until all potential conflicts have been assessed.
22 We do this by traversing the installation image(s) and recording the
23 actions that need to be performed.  Redundant actions are factored out,
24 e.g., we don't want to create a link that we will later remove in order to
25 create a directory.  Benefits of this approach
27     1. Get to see _all_ the conflicts that are blocking an installation: 
28        you don't have to deal with them one at a time.
29     2. No operations are be performed if _any_ conflicts are detected:
30        a failed stow will not leave you with a partially installed 
31        package.
32     3. Minimises the set of operations that need to be performed.
33     4. Operations are executed as a batch which is much faster
34        This can be an advantage when upgrading packages on a live system
35        where you want to minimise the amount of time when the package is
36        unavailable.
38 ** The above fixes the false conflict problem mentioned in the info file. 
40 ** It also fixes the two bugs mentioned in the man page.
42 ** Multiple stow directories will now cooperate in folding/unfolding.
44 ** Conflict messages are more uniform and informative. 
46 ** Verbosity and tracing is more extensive and uniform.
48 ** Implemented option parsing via Getopt::Long.
50 ** Default command line arguments set via '.stowrc' and '~/.stowrc' files.
52 Contents of these files are parsed as though they occurred first on the
53 command line.
55 ** Support multiple actions per invocation.
57 In order for this to work, we had to add a new (optional) command line arg
58 (-S) to specify packages to stow.  For example, to update an installation
59 of emacs you can now do
61         stow -D emacs-21.3 -S emacs-21.4a
63 which will replace emacs-21.3 with emacs-21.4a.
64 You can mix and match any number of actions, e.g.,
66         stow -S p1 p2 -D p3 p4 -S p5 -R p6
68 will unstow p3, p4 and p6, then stow p1, p2, p5 and p6.
70 ** New (repeatable) command line arg: --ignore='<regex>'
72 This suppresses operating on a file matching the regex (suffix), e.g.,
74         --ignore='~' --ignore='\.#.*'
76 will ignore emacs and CVS backup files (suitable for ~/.stowrc file).
78 (I opted for Perl regular expressions because they are more powerful and
79 easier to implement).
81 ** New (repeatable) command line arg: --defer='<regex>'
83 This defers stowing a file matching the regex (prefix) if that file is
84 already stowed to a different package, e.g.,
86         --defer='man' --defer='info'
88 will cause stow to skip over pre-existing man and info pages.
90 Equivalently, you could use --defer='man|info' since the argument is just
91 a Perl regex.
93 ** New (repeatable) command line arg: --override='<regex>'
95 This forces a file matching the regex (prefix) to be stowed even if the
96 file is already stowed to a different package, e.g.,
98         --override='man' --override='info'
100 will unstow any pre-existing man and info pages that would conflict with
101 the file we are trying to stow.
103 Equivalently, you could use --override='man|info' since the argument is
104 just a Perl regex.
106 ** The above gives the ability to manage packages with common content.
108 For example, man pages that are shared by a number of CPAN packages.
109 Using multiple stow directories and .stowrc files can also simplify
110 things.  In our setup we use the standard /usr/local/stow directory for
111 packages to be installed in /usr/local.  Since we install a large number
112 of extra Perl packages (currently about 300) we use an additional stow
113 directory: /usr/local/stow/perl-5.8.8-extras.  Both stow directories
114 contain a '.stow' file so that they collaborate appropriately.  I then use
115 the following .stowrc file in /usr/local/stow/perl-5.8.8-extras
116   
117         --dir=/usr/local/stow/perl-5.8.8-extras
118         --target=/usr/local
119         --override=bin
120         --override=man
121         --ignore='perllocal\.pod'
122         --ignore='\.packlist'
123         --ignore='\.bs'
125 When I stow packages from there, they automatically override any man pages
126 and binaries that may already have been stowed by another package or by
127 the core perl-5.8.8 installation.  For example, if you want to upgrade the
128 Test-Simple package, you need to override all the man pages that would
129 have been installed by the core package.  If you are upgrading CPAN, you
130 will also have to override the pre-existing cpan executable.
132 ** By default, search less aggressively for invalid symlinks when unstowing.
134 That is, we only search for bad symlinks in the directories explicitly
135 mentioned in the installation image, and do not dig down into other
136 subdirs.  Digging down into other directories can be very time consuming
137 if you have a really big tree (like with a couple of Oracle installations
138 lying around). In general the old behaviour is only necessary when you
139 have really stuffed up your installation by deleting a directory that has
140 already been stowed.  Doing that on a live system is somewhat crazy and
141 hopefully rare.  We provide an option '-p|--compat' to enable the old
142 behaviour for those needing to patch up mistakes.
144 ** New chkstow utility for checking the integrity of the target directory.
146 ** Implement a test suite and support code.  
148 This was built before implementing any of the extra features so I could
149 more easily check for equivalent functionality.  The initial code base had
150 to be refactored substantially to allow for testing.  The test suite is
151 not exhaustive, but it should provide enough to check for regressions.
153 * Changes in version 1.3.3
154 ** Now requires Perl 5.005 or later
155 ** Initially empty directories are not removed anymore
156 ** Removed buggy fastcwd (we use POSIX::getcwd instead)
157 ** Fixed bug when the common Parent of Target dir and Stow dir was "/"
158 ** Fixed bug when handling directories named "0"
159 ** Stow now only warns the user if a directory is unreadable during unstowing.
160 * Changes in version 1.3:
161 ** Added --restow option.
162 ** Fixed handling of slashes in package names.
163 ** Expanded configure-time search for Perl binary.
164 * Changes in version 1.2:
165 ** Dependency on `pwd' removed.
166 ** Perl 4 compatibility fixes.
167 ** Manual expanded even more.
168 * Changes in version 1.1:
169 ** Long and short options now accepted.
170 ** Manual expanded.
171 ** `make clean' removes stow (which is generated from stow.in).
172 * Initial public release (v1.0) of Stow.
173 * emacs local variables
174   Local Variables:
175   mode: org
176   End: