From ce5d61be326b65fc209ab5229eb343822daddecc Mon Sep 17 00:00:00 2001 From: Rusty Russell Date: Sat, 23 Feb 2019 19:40:08 +1030 Subject: [PATCH] CHANGELOG.md: order into user impact and coolness, while maintaining sections. Add the one 'Changelog-fixed' entry from a405c22fc9cffbe2a6c27a0a877db63224599817, and reorder a bit. Signed-off-by: Rusty Russell --- CHANGELOG.md | 19 ++++++++++--------- doc/MAKING-RELEASES.md | 4 +++- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 884c0452c..e96ee380a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - plugins: fully enabled, and ready for you to write some! - plugins: `pay` is now a plugin. - protocol: `pay` will now use routehints in invoices if it needs to. -- lightning-cli: `help ` finds man pages even if `make install` not run. +- JSON API: New command `paystatus` gives detailed information on `pay` commands. - JSON API: `getroute`, `invoice`, `sendpay` and `pay` commands `msatoshi` parameter can have suffixes `msat`, `sat` (optionally with 3 decimals) or `btc` (with 1 to 11 decimal places). @@ -25,25 +25,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - JSON API: `waitsendpay` now has an `erring_direction` field. - JSON API: `listpeers` now has a `direction` field in `channels`. - JSON API: `listchannels` now takes a `source` option to filter by node id. -- JSON API: New command `paystatus` gives detailed information on `pay` commands. - JSON API: `getroute` `riskfactor` argument is simplified; `pay` now defaults to setting it to 10. - JSON API: `sendpay` now takes a `bolt11` field, and it's returned in `listpayments` and `waitsendpay`. -- pylightning: New class 'Millisatoshi' can be used for JSON API, and new '_msat' fields are turned into this on reading. - JSON API: `fundchannel` and `withdraw` now have a new parameter `minconf` that limits coinselection to outputs that have at least `minconf` confirmations (default 1). (#2380) - JSON API: `listfunds` now displays addresses for all outputs owned by the wallet (#2387) - JSON API: `waitsendpay` and `sendpay` output field `label` as specified by `sendpay` call. - JSON API: `listpays` command for higher-level payment view than `listpayments`, especially important with multi-part-payments coming. - JSON API: `listpayments` is now `listsendpays`. +- lightning-cli: `help ` finds man pages even if `make install` not run. +- pylightning: New class 'Millisatoshi' can be used for JSON API, and new '_msat' fields are turned into this on reading. ### Changed -- The `short_channel_id` separator has been changed to be `x` to match the specification. +- protocol: `option_data_loss_protect` is now enabled by default. +- JSON API: The `short_channel_id` separator has been changed to be `x` to match the specification. - JSON API: `listpeers` now includes `funding_allocation_msat`, which returns a map of the amounts initially funded to the channel by each peer, indexed by channel id. -- `option_data_loss_protect` is now enabled by default. - JSON API: `help` with a `command` argument gives a JSON array, like other commands. - JSON API: `sendpay` `description` parameter is renamed `label`. -- build: we'll use the system libbase58 and libsodium if found suitable. - JSON API: `pay` now takes an optional `label` parameter for labelling payments, in place of never-used `description`. +- build: we'll use the system libbase58 and libsodium if found suitable. ### Deprecated @@ -68,14 +68,15 @@ provide appropriate suffixes for JSON input fields. - Protocol: handling `query_channel_range` for large numbers of blocks (eg. 4 billion) was slow due to a bug. - Fixed occasional deadlock with peers when exchanging huge amounts of gossip. -- You can no longer make giant unpayable "wumbo" invoices. -- CLTV of total route now correctly evaluated when finding best route. -- `riskfactor` arguments to `pay` and `getroute` now have an effect. +- Fixed a crash when running in daemon-mode due to db filename overrun (#2348) - Handle lnd sending premature 'funding_locked' message when we're expected 'reestablish'; we used to close channel if this happened. - Cleanup peers that started opening a channel, but then disconnected. These would leave a dangling entry in the DB that would cause this peer to be unable to connect. (PR #2371) +- You can no longer make giant unpayable "wumbo" invoices. +- CLTV of total route now correctly evaluated when finding best route. +- `riskfactor` arguments to `pay` and `getroute` now have an effect. ### Security diff --git a/doc/MAKING-RELEASES.md b/doc/MAKING-RELEASES.md index 9ef973283..0772e3791 100644 --- a/doc/MAKING-RELEASES.md +++ b/doc/MAKING-RELEASES.md @@ -13,7 +13,9 @@ Here's a checklist for the release process. ### Prepering for -rc1 -1. Check that CHANGELOG.md covers all signficant changes. +1. Check that CHANGELOG.md is well formetted, ordered in areas, + covers all signficant changes, and sub-ordered approximately by user impact + & coolness. 2. Update the CHANGELOG.md with [Unreleased] changed to -rc1, and add a new footnote. 3. Create a PR with the above.