Skip to content

Commit 34c3d04

Browse files
committed
doc: Bump version number
Increase version number after previous version was added to bitcoin core. Also update version history and documentation.
1 parent d0fc108 commit 34c3d04

File tree

2 files changed

+42
-19
lines changed

2 files changed

+42
-19
lines changed

doc/versions.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,40 +7,55 @@ Library versions are tracked with simple
77
Versioning policy is described in the [version.h](../include/mp/version.h)
88
include.
99

10-
## v7
10+
## v8
1111
- Current unstable version in master branch.
12-
- Intended to be compatible with Bitcoin Core 30.1 and future releases.
12+
13+
## v7.0
14+
- Adds SpawnProcess race fix, cmake `target_capnp_sources` option, ci and documentation improvements.
15+
- Used in Bitcoin Core master branch, pulled in by [#34363](https://github.com/bitcoin/bitcoin/pull/34363).
16+
17+
## v7.0-pre1
18+
19+
- Adds support for log levels to reduce logging and "thread busy" error to avoid crash on misuse. Fixes intermittent mptest hang and makes other minor improvements.
20+
- Used in Bitcoin Core 30.1 and 30.2 releases and 30.x branch. Pulled in by [#33412](https://github.com/bitcoin/bitcoin/pull/33412), [#33518](https://github.com/bitcoin/bitcoin/pull/33518), and [#33519](https://github.com/bitcoin/bitcoin/pull/33519).
1321

1422
## v6.0
15-
- `EventLoop::addClient` and `EventLoop::removeClient` methods dropped,
23+
24+
- Adds fixes for unclean shutdowns and thread sanitizer issues and add CI scripts.
25+
- Drops `EventLoop::addClient` and `EventLoop::removeClient` methods,
1626
requiring clients to use new `EventLoopRef` class instead.
17-
- Compatible with Bitcoin Core 30.0 release.
27+
- Used in Bitcoin Core 30.0 release. Pulled in by [#31741](https://github.com/bitcoin/bitcoin/pull/31741), [#32641](https://github.com/bitcoin/bitcoin/pull/32641), [#32345](https://github.com/bitcoin/bitcoin/pull/32345), [#33241](https://github.com/bitcoin/bitcoin/pull/33241), and [#33322](https://github.com/bitcoin/bitcoin/pull/33322).
1828

1929
## v5.0
30+
- Adds build improvements and tidy/warning fixes.
31+
- Used in Bitcoin Core 29 releases, pulled in by [#31945](https://github.com/bitcoin/bitcoin/pull/31945).
32+
33+
## v5.0-pre1
34+
- Adds many improvements to Bitcoin Core mining interface: splitting up type headers, fixing shutdown bugs, adding subtree build support.
2035
- Broke up `proxy-types.h` into `type-*.h` files requiring clients to explicitly
2136
include overloads needed for C++ ↔️ Cap'n Proto type conversions.
2237
- Now requires C++ 20 support.
23-
- Compatible with Bitcoin Core 29 releases.
38+
- Minimum required version for Bitcoin Core 29 releases, pulled in by [#30509](https://github.com/bitcoin/bitcoin/pull/30509), [#30510](https://github.com/bitcoin/bitcoin/pull/30510), [#31105](https://github.com/bitcoin/bitcoin/pull/31105), [#31740](https://github.com/bitcoin/bitcoin/pull/31740).
2439

2540
## v4.0
2641
- Added better cmake support, installing cmake package files so clients do not
2742
need to use pkgconfig.
28-
- Compatible with Bitcoin Core 28 releases.
43+
- Used in Bitcoin Core 28 releases, pulled in by [#30490](https://github.com/bitcoin/bitcoin/pull/30490) and [#30513](https://github.com/bitcoin/bitcoin/pull/30513).
2944

3045
## v3.0
3146
- Dropped compatibility with Cap'n Proto versions before 0.7.
32-
- Compatible with Bitcoin Core 27 releases.
47+
- Used in Bitcoin Core 27 releases, pulled in by [#28735](https://github.com/bitcoin/bitcoin/pull/28735), [#28907](https://github.com/bitcoin/bitcoin/pull/28907), and [#29276](https://github.com/bitcoin/bitcoin/pull/29276).
3348

3449
## v2.0
3550
- Changed `PassField` function signature.
3651
- Now requires C++17 support.
37-
- Compatible with Bitcoin Core 25 and 26 releases.
52+
- Used in Bitcoin Core 25 and 26 releases, pulled in by [#26672](https://github.com/bitcoin/bitcoin/pull/26672).
3853

3954
## v1.0
4055
- Dropped hardcoded includes in generated files, now requiring `include` and
4156
`includeTypes` annotations.
42-
- Compatible with Bitcoin Core 22, 23, and 24 releases.
57+
- Used in Bitcoin Core 22, 23, and 24 releases, pulled in by [#19160](https://github.com/bitcoin/bitcoin/pull/19160).
4358

4459
## v0.0
4560
- Initial version used in a downstream release.
46-
- Compatible with Bitcoin Core 21 releases.
61+
- Used in Bitcoin Core 21 releases, pulled in by [#16367](https://github.com/bitcoin/bitcoin/pull/16367), [#18588](https://github.com/bitcoin/bitcoin/pull/18588), and [#18677](https://github.com/bitcoin/bitcoin/pull/18677).

include/mp/version.h

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,30 @@
55
#ifndef MP_VERSION_H
66
#define MP_VERSION_H
77

8-
//! Major version number. Should be incremented in the master branch before
9-
//! changes that introduce major new features or break API compatibility, if
10-
//! there are clients relying on the previous API. (If an API changes multiple
11-
//! times and nothing uses the intermediate changes, it is sufficient to
12-
//! increment this only once before the first change.)
8+
//! @file
9+
//! @brief Major and minor version numbers
10+
//!
11+
//! Versioning uses a cruder form of SemVer where the major number is
12+
//! incremented with all significant changes, regardless of whether they are
13+
//! backward compatible, and the minor number is treated like a patch level and
14+
//! only incremented when a fix or backport is applied to an old branch.
15+
16+
//! Major version number. Should be incremented after any release or external
17+
//! usage of the library (like a subtree update) so the previous number
18+
//! identifies that release. Should also be incremented before any change that
19+
//! breaks backward compatibility or introduces nontrivial features, so
20+
//! downstream code can use it to detect compatibility.
1321
//!
1422
//! Each time this is incremented, a new stable branch should be created. E.g.
1523
//! when this is incremented to 8, a "v7" stable branch should be created
1624
//! pointing at the prior merge commit. The /doc/versions.md file should also be
1725
//! updated, noting any significant or incompatible changes made since the
18-
//! previous version, and backported to the stable branch before it is tagged.
19-
#define MP_MAJOR_VERSION 7
26+
//! previous version.
27+
#define MP_MAJOR_VERSION 8
2028

2129
//! Minor version number. Should be incremented in stable branches after
22-
//! backporting changes. The /doc/versions.md file in the master and stable
23-
//! branches should also be updated to list the new minor version.
30+
//! backporting changes. The /doc/versions.md file should also be updated to
31+
//! list the new minor version.
2432
#define MP_MINOR_VERSION 0
2533

2634
#endif // MP_VERSION_H

0 commit comments

Comments
 (0)