Skip to content

Commit 8e12ee4

Browse files
committed
Updated CHANGELOG.md files
1 parent d231bb6 commit 8e12ee4

File tree

7 files changed

+74
-10
lines changed

7 files changed

+74
-10
lines changed

typed-protocols-cborg/CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Revision history for typed-protocols-cborg
22

3+
## 0.3.0.0
4+
5+
* bumped version to agree with `typed-protocols-stateful-0.3.0.0`
6+
7+
## 0.2.0.0
8+
9+
* updated to use `typed-protocols-0.2.0.0`
10+
311
## 0.1.0.0 -- 2021-07-28
412

513
* Initial experiments and prototyping
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Revision history of typed-protocols-stateful
2+
3+
## 0.3.0.0
4+
5+
* bumped version to agree with `typed-protocols-stateful-0.3.0.0`, in particular:
6+
when encoding the local state associated to the initial message state is
7+
passed to the codec.
8+
9+
## 0.2.0.0
10+
11+
* Initial version
12+
Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
# Revision history for typed-protocols-cborg
1+
# Revision history for typed-protocols-stateful-cborg
22

3-
## 0.1.0.0 -- 2021-07-28
3+
## 0.3.0.0
44

5-
* Initial experiments and prototyping
5+
* bumped version to agree with `typed-protocols-stateful-0.3.0.0`, in particular:
6+
when encoding the local state associated to the initial message state is
7+
passed to the codec.
8+
9+
## 0.2.0.0
10+
11+
* Initial version
612

typed-protocols-stateful-cborg/typed-protocols-stateful-cborg.cabal

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ category: Control
1414
build-type: Simple
1515

1616
-- These should probably be added at some point.
17-
extra-source-files: ChangeLog.md, README.md
17+
extra-source-files: CHANGELOG.md, README.md
1818

1919
library
2020
exposed-modules: Network.TypedProtocol.Stateful.Codec.CBOR

typed-protocols-stateful/CHANGELOG.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Revision history of typed-protocols-stateful
2+
3+
## 0.3.0.0
4+
5+
* when encoding a message the local state associated to the initial message
6+
state, rather than final state, is passed to the codec. For that reason:
7+
* `Yield` requires local state associated to both the initial and final protocol state
8+
* `Codec` and `Driver` have changed accordingly
9+
10+
This change eliminates the need to have add extra fields in messages which
11+
are not send over the wire, see the `Network.TypedProtocol.Stateful.ReqResp`
12+
example.
13+
* `AnyMessage` takes only the local state associated to the initial protocol state of the `Message`.
14+
* Removed `Show` instance of `AnyMessage`, provided instead `showAnyMessage`.
15+
* `AnyMessageWithAgency` pattern synonym is exported as a constructor of `AnyMessage`.
16+
* constraints of `prop_*` APIs where changed.
17+
18+
## 0.2.0.0
19+
20+
* Initial version

typed-protocols-stateful/typed-protocols-stateful.cabal

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ author: Marcin Szamotulski
1212
maintainer: [email protected]
1313
category: Control
1414
build-type: Simple
15+
extra-source-files: CHANGELOG.md
1516

1617
-- These should probably be added at some point.
1718
-- extra-source-files: ChangeLog.md, README.md

typed-protocols/CHANGELOG.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,28 @@
11
# Revision history for typed-protocols
22

3-
## [Unreleased]
4-
5-
- A major redesign of `typed-protocols`. `Protocol` class requires data family
6-
`Message` and new associated type familiy instance `StateAgency`. One also
7-
needs to define singletons and `Sing` & `SingI` instances from the
8-
[`singletons`][singletons-3.0.1] package.
3+
## 0.3.0.0
4+
5+
* `AnyMessageWithAgency` pattern synonym is exported as a constructor of `AnyMessage`.
6+
* Bumped version to agree with `typed-protocols-stateful`.
7+
8+
## 0.2.0.0
9+
10+
* A major redesign of `typed-protocols`.
11+
* `Protocol` class does not require to provide proof obligations for agancy.
12+
Proofs are now provided by the framework for all protocols. Agency is now
13+
provided by an associated type family `StateAgency`, and evidence for it,
14+
in form of a singleton, by `StateToken` type family
15+
(similar to `Sing` from the `singletons` package).
16+
* `Peer` takes a different evidence type for agency,
17+
`Network.TypedProtocol.Peer.{Client,Server}` modules provide pattern synonyms
18+
which provide agency evidence and thus are easier to use.
19+
* One `Peer` is provided for both non- and pipelined protocol evolution.
20+
An extra parameter is added of kind `IsPipelined`. As a result
21+
`Outstanding` is now a type family rather than a type alias.
22+
* `ActiveAgency` type class is used to distinguish states in which one side
23+
has an agency (e.g. the protocol hasn't yet terminated), `nonActiveState` can
24+
be used in the same way as `Data.Void.absurd` - which is useful when writing
25+
codecs.
926

1027
## 0.1.1.1
1128
* unbuildable (with `base < 0` constraint in CHaP); We cannot support

0 commit comments

Comments
 (0)