Better late then never, this bundle demonstrates the kind of NEWS file I've been talking about for some time. Key points:
- It's called NEWS, and the intended audience is end users, NOT developers. Developers can use "darcs changes". The NEWS file is written by a human and contains very high-level summary of what is new in each version. Think of it as answering the question "why should I bother upgrading?" - A huge thanks to Petr and Thorkil, who produced the content that I used to seed this entry, when I was too lazy to. - Try to keep each point one line long. To this end (and because end users probably don't care) I have deleted the attributions and rewritten some entries. If a point spans multiple lines, add a blank line after it. - Points are sorted in (approximately) descending order of importance, except that multi-line points get pushed to the bottom of the list. - Add a page break (^L) on its own line after each major (x+1.y.z) or minor (x.y+1.z) release. This makes it easier to hop between releases with e.g. C-x ] in Emacs. - Rather than ChangeLog-style attribution of the release to the release manager, I have stuck the release date (which end users might care about) on the heading line. Hopefully this is more readable, but if people oppose to this then I won't fight for it. - Hopefully in future I/we get the entry applied prior to tagging the release >sheepish< :-) Thu Jan 22 17:39:59 EST 2009 Trent W. Buck <[email protected]> * Use conventional name "NEWS" for "new in $version" notes. Thu Jan 22 17:40:14 EST 2009 Trent W. Buck <[email protected]> * NEWS for Darcs 2.2.0. Thu Jan 22 17:41:07 EST 2009 Trent W. Buck <[email protected]> * Syntax highlighting for new-style NEWS entries.
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 New patches: [Use conventional name "NEWS" for "new in $version" notes. Trent W. Buck <[email protected]>**20090122063959] move ./ChangeLog ./NEWS [NEWS for Darcs 2.2.0. Trent W. Buck <[email protected]>**20090122064014] hunk ./NEWS 1 +Darcs 2.2.0, 16 Jan 2009 + + * Important changes in Darcs 2.2.0 + + * Support for GHC 6.10. + * Improved Windows support. + * Cabal is now supported as a build method for darcs. + * Low-level optimisations in filesystem code. + * Overhaul of the make-based build system. + * Extensive manual and online help improvements. + * Improved API documentation (haddock) for existing darcs modules. + * Improvements in the testing infrastructure. + * Improved performance for "darcs repair". + * Improved robustness for "darcs check". + * Numerous major and minor bug fixes, refactorings and cleanups. + * When recording interactively it is now possible to list all + currently selected hunks (command 'l'). + + * It is now possible to specify --in-reply-to when using darcs send, + to generate correct references in the mail header. + + * Repositories can no longer be created with --no-pristine-tree. + This only affects the legacy darcs-1 repository format. + + * Experimental Darcs library, providing increase flexibility and + efficiency to third-party utilities (compared to the command-line + interface). Only built via Cabal. NOT a stable API yet. + + * Bugs Fixed in Darcs 2.2.0 + + See http://bugs.darcs.net/issueN for details on bug number N. + + * 525 amend-record => darcs patches show duplicate additions + * 971 darcs check fails (case sensitivity on filenames) + * 1006 darcs check and repair do not look for adds + * 1043 pull => mergeAfterConflicting failed in geteff (2.0.2+) + * 1101 darcs send --cc recipient not included in success message + * 1117 Whatsnew should warn on non-recorded files + * 1144 Add darcs send --in-reply-to or --header "In-Reply-To:... + * 1165 get should print last gotten tag + * 1196 Asking for changes in /. of directory that doesn't exist... + * 1198 Reproducible "mergeConflictingNons failed in geteff with ix" + * 1199 Backup files darcs added after external merge + * 1223 sporadic init.sh test failure (2.1.1rc2+472) + * 1238 wish: darcs help setpref should list all prefs + * 1247 make TAGS is broken + * 1249 2.1.2 (+ 342 patches) local drive detection on Windows error + * 1272 amend-record not the same as unrecord + record + * 1273 renameFile: does not exist (No such file or directory) + * 1223 sporadic init.sh test failure (2.1.1rc2+472) + + darcs (2.1.2) * Quality Assurance: Disable a new test that was not yet working [Syntax highlighting for new-style NEWS entries. Trent W. Buck <[email protected]>**20090122064107] hunk ./NEWS 2253 Local variables: mode: outline - -outline-regexp: "d\\| \\*" +outline-regexp: "[dD]\\| +\\*+" +paragraph-separate: "[ ]*$" end: Context: [Refactor initial argument dispatcher. Trent W. Buck <[email protected]>**20090117081533 Ignore-this: fe101e61cc7b46a8c6b4415f08c737b ] [Simplify some of my own code. Trent W. Buck <[email protected]>**20090117015505 Ignore-this: 42a7df5c21ae0416441572380490e127 ] [Haddocks for HashedIO [email protected]**20090116170955 Ignore-this: 1c54191a243bd11d6d22d74600251587 ] [Haddocks for Cache [email protected]**20090116170931 Ignore-this: 3aa035bd5f805929113a616df9faefb6 ] [Haddock for Darcs.External.fetchFile [email protected]**20090116170742 Ignore-this: 96041231ca2800c3fcde4f56ec49e267 ] [Refactor: use more guards. Trent W. Buck <[email protected]>**20090115072617 Ignore-this: b41bb970198ed1f42aebdfc63c90e115 ] [Resolve issue1311: Use time zones from GNU coreutils; improve doc. Dave Love <[email protected]>**20090112135012 Ignore-this: 883bc4ccdb1d27fde14ec9c76a4d2a45 ] [omit empty line at the end of output in darcs diff Christian Kellermann <[email protected]>**20090114110607 Ignore-this: d71a3d5460fbe21244c4eba77dc47885 ] [Clean up when previous test crashed. Trent W. Buck <[email protected]>**20090113001345] [Make "make clean" remove microbench. Trent W. Buck <[email protected]>**20090111152130 Put the clean target directly below the build target, so it's harder to get them out of sync in future. ] [Fix test optimize_relink.sh when no hard linking available Thorkil Naur <[email protected]>**20090113223335 The semicolon in the echo command causes the test to fail with the message > optimize_relink.sh: line 37: assuming: command not found when no hard linking is available. ] [Consistently use sh (not csh) prompts in user manual. Trent W. Buck <[email protected]>**20090111114801 The sh prompt ($) was already used elsewhere in the manual, and I choose to standardize on it instead of csh (%) because sh (especially bash) seems more widespread and recognizable as the user shell prompt. ] [resolve issue1270: don't show the motd when --xml-output is given [email protected]**20090109090726 Ignore-this: e1dae49ceb510668a1358e2103268cc3 ] [Get setpref description in manual. Dave Love <[email protected]>**20090111151941 Ignore-this: 89b0d00a82582d03fdf51cd9822dba65 ] [Example for issue1284. Trent W. Buck <[email protected]>**20090111051101] [resolve issue1235: added --summary to obliterate Rob Hoelz <[email protected]>**20090110032907] [Haddock for Darcs.Repository.Format Florent Becker <[email protected]>**20090108160035 Ignore-this: f88f0223ebbbe5694845dd1060e6f978 ] [Remove stale comment (we now require GHC 6.6) Eric Kow <[email protected]>**20081231080929 Ignore-this: b19da9fabc8d2e38bccafc84a77fa278 ] [do not use concatenation in src/Context.hs Florent Becker <[email protected]>**20090107135552 Ignore-this: 9e86505a445730b7653e75f08e8ff81e ] [Print malicious paths and optional way around them when they cause a failure. David Caldwell <[email protected]>**20090105101628 Ignore-this: cdb706087869e19e046bc0dd424ca38d ] [Fix typo in --dont-restrict-paths documentation. David Caldwell <[email protected]>**20090105024208 Ignore-this: 16197eeef34dedddeda036b47747f234 ] [Add --restrict-paths (and --dont-restrict-paths) to "darcs apply". David Caldwell <[email protected]>**20090102101737 Ignore-this: f6ab937573bf0d5397361ddefed902c9 ] [Add --restrict-paths (and --dont-restrict-paths) to "darcs pull". David Caldwell <[email protected]>**20090102101726 Ignore-this: dd3bc04632d341be16709e0aee6753ec ] [Revert --restrict-paths removal. David Caldwell <[email protected]>**20090102101705 Ignore-this: 1fba1f9a589aaabb1fa27a268f7c972e ] [Resolve issue1302: set closed bugs to resolved (not resolved-in-unstable). Trent W. Buck <[email protected]>**20090105001351] [make stringify cut the string [email protected]**20090104102125 Ignore-this: e1a0cd83fce5085f60b812d894ca26e7 This avoids choking utilities such as grep (or emacs' internal grep) which parse haskell files line-by-line. ] [make unit's return value depend on all tests Florent Becker <[email protected]>**20090102184930 Ignore-this: fce3636c70bcb4a80413823c88e3ac6a ] [Resolve issue1285: remove "cabal test" intermediaries. Trent W. Buck <[email protected]>**20090103095347] [Resolve issue1206: Countable Nouns. Trent W. Buck <[email protected]>**20090101062452 Use the conventional term "Countable" instead of "Numbered". ] [Improve readability of bug reporting. Trent W. Buck <[email protected]>**20081226120833 Moving "at <location>" to the first line gives the descriptive string a line all to itself. For example, darcs show bug: darcs: bug at src/Darcs/Commands/ShowBug.lhs:57 compiled Nov 4 2008 12:05:43 This is actually a fake bug in darcs. ] [Use imperative mood for primitive matcher help. Trent W. Buck <[email protected]>**20081228114434] [Check GADT witnesses when doing Cabal-based builds. Petr Rockai <[email protected]>**20081228111229] [Fix haddock error Eric Kow <[email protected]>**20081227204218 Ignore-this: 60f05d20e5f37312f6b477067114fac7 ] [Haddock for primitiveMatchers (untested). Trent W. Buck <[email protected]>**20081227141921] [Rewrite primitive matcher examples. Trent W. Buck <[email protected]>**20081227141845] [Rewrite "darcs help --match" output. Trent W. Buck <[email protected]>**20081227141819 Add an introductory paragraph, and put all the examples into a single code block, since one-line paragraphs are kind hard to read. ] [Delete superfluous "Introduction" headings. Trent W. Buck <[email protected]>**20081227034129 I don't think it's useful to grant a subsection heading to the single introductory paragraph of a section. ] [Refactor error text for readability. Trent W. Buck <[email protected]>**20081109144007] [Tweak user manual's title page. Trent W. Buck <[email protected]>**20081227011031 It annoyed me that the user manual was just called "Darcs", not "Darcs User Manual". ] [Improve readability of bug reporting. Trent W. Buck <[email protected]>**20081226104243 Moving "at <location>" to the first line gives the descriptive string a line all to itself. For example, darcs show bug: darcs: bug at src/Darcs/Commands/ShowBug.lhs:57 compiled Nov 4 2008 12:05:43 This is actually a fake bug in darcs. ] [Haddockize developer comment. Trent W. Buck <[email protected]>**20081214041902] [Darcs.ColorPrinter: factor out getPolicy call [email protected]**20081222180227 Ignore-this: aee5b5415ee8bbfe1dac06e240b90080 Less redundancy. 'getPolicy' is being called with the same args, and it's not like the environmental variables are going to change in between each call. ] [Make it possible to run just specific tests from cabal commandline. Petr Rockai <[email protected]>**20081223083742 All of `cabal test repair-corrupt bugs/newlines bugs/issue27.sh` should work as expected. The implementation is not very efficient, but seems to work fine. ] [Neatify "cabal test" option munging in Setup.lhs. Petr Rockai <[email protected]>**20081223080811] [Sort the list of tests that are run by cabal. Petr Rockai <[email protected]>**20081223073642] [Remove now-unused replacePristine. Petr Rockai <[email protected]>**20081210065138] [resolve issue948: rewrite darcsman. Trent W. Buck <[email protected]>**20081221081934 Significant changes are: - Avoid duplicating groups from TheCommands. - Due to growing command_helps, list commands in SYNOPSIS. - Use subsections (.SS) for groups. - Include (with fancy markup!) command arguments. - Include darcs help --match. - Copy-and-paste description from darcs.cabal. - Remove AUTHORS section as suggested by man-pages(7). - Declare my copyright. ] [Tweak punctuation in "darcs help --match". Trent W. Buck <[email protected]>**20081221080949 Manpages treat apostrophes in the first line specially. Use `TeX style' quotes instead, so this string can be included in the manpage. Also omit mention of &&, || and ! until I find time to clarify that they are aliases for the human-readable and, or and not. ] [TAG 2.2.0 Petr Rockai <[email protected]>**20090115150916] Patch bundle hash: 2d152b3497588990fb8cfca4bd4a3589c16b3f2d -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.9 (GNU/Linux) iEYEARECAAYFAkl4FXQACgkQLpef9iTtxAYSAQCgpnNsDmxg/uIihIni8dF924Nq 4HkAoMeWAMCz3p/1K8sRpBwgagZ0gN01 =9lCa -----END PGP SIGNATURE-----
_______________________________________________ darcs-users mailing list [email protected] http://lists.osuosl.org/mailman/listinfo/darcs-users
