HISTORY.markdown in binman-3.0.0 vs HISTORY.markdown in binman-3.0.1

- old
+ new

@@ -1,121 +1,147 @@ ------------------------------------------------------------------------------ +Version 3.0.1 (2012-02-02) +------------------------------------------------------------------------------ + +Patch: + + * BinMan.help(): ignore `-h` and `--help` options after standard `--` flag. + + * BinMan.show(): write temp file because not all systems support `man -l`. + +Other: + + * HISTORY: group changes by version number components. + + * README: add instructions on pre-building man pages. + + * README: fix installation commands for development. + + * bundler suggests moving all dev deps into gemspec. + +------------------------------------------------------------------------------ Version 3.0.0 (2012-01-09) ------------------------------------------------------------------------------ -Breaking changes: +Major: -* Removed the `binman/gemspec` helper library because it did not play well - with Bundler. Use the standard `add_runtime_dependency` method instead. + * Removed the `binman/gemspec` helper library because it did not play well + with Bundler. Use the standard `add_runtime_dependency` method instead. + [This example][1] shows what work is involved in upgrading. -External changes: +Minor: -* The `binman/Rakefile` helper library now hooks into Bundler's Rake tasks. + * The `binman/Rakefile` helper library now hooks into Bundler's Rake tasks. + Be sure to add the `man/**/*` files to your gemspec [accordingly][1]. +[1]: https://github.com/sunaku/md2man/commit/75d7a0064fa86f1c98dd01391ad82245fd387c20 + ------------------------------------------------------------------------------ Version 2.0.0 (2011-12-06) ------------------------------------------------------------------------------ -Breaking changes: +Major: -* Removed the deprecated `binman/rake_tasks` helper library. Use - `binman/rakefile` instead. + * Removed the deprecated `binman/rake_tasks` helper library. Use + `binman/rakefile` instead. -External changes: +Patch: -* Fixed infinite looping in the `binman/gemspec` helper library. + * Fixed infinite looping in the `binman/gemspec` helper library. -Internal changes: +Other: -* Upgraded to md2man v1 for Markdown to UNIX man page conversion. + * Upgraded to md2man v1 for Markdown to UNIX man page conversion. -* Do not hard-code the version number in `binman/gemspec` helper. + * Do not hard-code the version number in `binman/gemspec` helper. ------------------------------------------------------------------------------ Version 1.1.0 (2011-11-05) ------------------------------------------------------------------------------ -Compatible changes: +Alert: -* The `binman/rake_tasks` library has been renamed (with deprecation) to - `binman/rakefile`. The deprecation warning will be removed in the next - major release. + * The `binman/rake_tasks` library has been renamed (with deprecation) to + `binman/rakefile`. The deprecation warning will be removed in the next + major release. -New features: +Minor: -* Add `binman/gemspec` packaging convenience library which automatically - builds and includes your UNIX man page files in your gem packages and also - adds binman as a runtime and development gem dependency. + * Add `binman/gemspec` packaging convenience library which automatically + builds and includes your UNIX man page files in your gem packages and also + adds binman as a runtime and development gem dependency. ------------------------------------------------------------------------------ Version 1.0.0 (2011-10-13) ------------------------------------------------------------------------------ -Incompatible changes: +Major: -* The `BinMan::dump()` method and corresponding `binman dump` command now - extract the leading comment header from their input before returning the - markdown to roff conversion thereof. + * The `BinMan::dump()` method and corresponding `binman dump` command now + extract the leading comment header from their input before returning the + markdown to roff conversion thereof. -* The `BinMan::read()` method and corresponding `binman read` command have - been renamed to `BinMan::load()` and `binman load` respectively. + * The `BinMan::read()` method and corresponding `binman read` command have + been renamed to `BinMan::load()` and `binman load` respectively. -New features: +Minor: -* Added `BinMan::conv()` method and corresponding `binman conv` command to - encapsulate the markdown to roff conversion process. + * Added `BinMan::conv()` method and corresponding `binman conv` command to + encapsulate the markdown to roff conversion process. -Bug fixes: +Patch: -* Pre-built man pages included alongside a `bin/` script were not displayed. - Instead, binman was (incorrectly) always trying to convert the leading - comment header from the `bin/` script into a UNIX man page for display. + * Pre-built man pages included alongside a `bin/` script were not displayed. + Instead, binman was (incorrectly) always trying to convert the leading + comment header from the `bin/` script into a UNIX man page for display. -Housekeeping: +Other: -* README: explain dev deps and `man/` dir packaging. + * README: explain dev deps and `man/` dir packaging. ------------------------------------------------------------------------------ Version 0.1.2 (2011-10-13) ------------------------------------------------------------------------------ -Housekeeping: +Minor: -* Extracted `BinMan::Renderer` into [redcarpet-manpage] library. + * The [Redcarpet2] library is not a runtime gem dependency anymore. -* The [Redcarpet2] library is not a runtime gem dependency anymore. +Other: -* Forgot to introduce leading comment headers in binman(1) man page. + * Extracted `BinMan::Renderer` into [redcarpet-manpage] library. + * Forgot to introduce leading comment headers in binman(1) man page. + [Redcarpet2]: https://github.com/tanoku/redcarpet [redcarpet-manpage]: http://rdoc.info/github/sunaku/redcarpet-manpage ------------------------------------------------------------------------------ Version 0.1.1 (2011-10-13) ------------------------------------------------------------------------------ -New features: +Minor: -* `BinMan.read()` now supports embedded document (=begin/=end) comments also. - See binman(1) for the new, complete description of leading comment headers. + * `BinMan.read()` now supports embedded document (=begin/=end) comments + also. See binman(1) for the new description of leading comment headers. -Bug fixes: +Patch: -* Ignore encoding comment line after shebang line. + * Ignore encoding comment line after shebang line. -* roff: fix first paragraphs inside list items. + * roff: fix first paragraphs inside list items. -Housekeeping: +Other: -* gemspec: build man page files before building gem. + * gemspec: build man page files before building gem. -* binman: raise error and suggest --help option. + * binman: raise error and suggest --help option. -* README: add link to example of binman markdown. + * README: add link to example of binman markdown. -* README: add obligatory screenshot! >:-) + * README: add obligatory screenshot! >:-) ------------------------------------------------------------------------------ Version 0.0.1 (2011-10-12) ------------------------------------------------------------------------------ -* First release! Happy birthday! Woohoo! :-) +First release! Happy birthday! Woohoo! :-)