]> sjero.net Git - wget/blob - ChangeLog.README
[svn] Document the new windows ChangeLog.
[wget] / ChangeLog.README
1 Please note that Wget has more than one ChangeLog file:
2
3     ./ChangeLog: documents changes to files in the top-level directory
4                  and to files in subdirectories like po/ that don't have
5                  their own ChangeLogs 
6
7     src/ChangeLog: documents only changes to files in the src directory
8
9     doc/ChangeLog: documents only changes to files in the doc directory
10
11     windows/ChangeLog: documents only changes to files in the windows directory
12
13 When checking to see if a patch you sent in has been applied, please
14 look in the appropriate ChangeLog(s).
15
16 In addition, you'll notice the ChangeLog-branches directories.
17
18 In late 2000, time constraints delayed the release of Wget 1.6.  While
19 it was awaiting release, people had new features and other changes they
20 wanted added to the CVS archive, but these were deemed not safe to
21 introduce just before a release.
22
23 The solution was to split the stable 1.6 off onto its own branch, while
24 free-wheeling development continued on the main branch (whose version
25 was changed from 1.5.3+dev to 1.7-dev).
26
27 Unfortunately it's difficult to portray this branched development in the
28 flat ChangeLog file.  Either you include 1.6-branch changes in the
29 1.7-branch ChangeLog, in which case it becomes impossible to tell what
30 release version a given change first went into Wget, just judging by
31 date and position in the ChangeLog, or you omit all 1.6-branch changes
32 from the 1.7-branch ChangeLog, in which case all evidence of the
33 existence of 1.6 (and further information about that branch) disappears
34 from future versions of Wget.
35
36 The solution that was decided upon was to make a subdirectory called
37 ChangeLog-branches adjacent to each ChangeLog file.  Inside is the
38 corresponding ChangeLog from the most recent release on the stable
39 branch (e.g. 1.6_branch.ChangeLog).  This way, no information is lost
40 and there's no misleading information in the ChangeLog.