Merge pull request #13 from distrap/srk/changelogs

Start changelogs

ivory-backend-c/CHANGELOG.md

@@ -0,0 +1,19 @@
+TODO: next should be `0.2.0.0`, tag should be `ivory-backend-c-0.2.0.0`
+
+# Version [next](https://github.com/distrap/ivory/compare/0.1.0.4...main) (2024-MM-DD)
+
+## Fixed wrong order of arugments for `logBase`
+
+This incorrectly generated `logBase base x = log base / log x`
+instead of `logBase base x = log x / log base`
+
+## Now emits initializer for structs with empty initilizer [#10](https://github.com/distrap/ivory/pull/10/commits/c9c2584b3be75b965780d11ca16121d0274b4083)
+
+Shaves off a GCC warning by emitting `={0};` for structs with empty initilizer.
+
+---
+
+`ivory-backend-c` uses [PVP Versioning][1].
+
+[1]: https://pvp.haskell.org
+

ivory-backend-c/ivory-backend-c.cabal

@@ -13,6 +13,7 @@ data-files:             runtime/ivory.h,
                         runtime/ivory_asserts.h
 license:             BSD-3-Clause
 license-file:        LICENSE
+extra-doc-files:     CHANGELOG.md
 source-repository    this
   type:     git
   location: https://github.com/distrap/ivory

ivory/CHANGELOG.md

@@ -0,0 +1,60 @@
+TODO: next should be `0.2.0.0`, tag should be `ivory-0.2.0.0`
+
+# Version [next](https://github.com/distrap/ivory/compare/0.1.0.4...main) (2024-MM-DD)
+
+Changelog started
+
+## Breaking changes
+
+### `IvoryRef` class removed [#12](https://github.com/distrap/ivory/pull/12)
+
+For migrating
+- Remove `IvoryRef r` and `IvoryExpr` contstraints, add `KnownCostancy c` one
+- Replace `r s` type with `Pointer 'Valid c s`
+
+For example:
+
+```diff
+-arrayCopyFromOffset :: ( ANat n, ANat m, IvoryRef r
+-                       , IvoryExpr (r s2 ('Array m ('Stored t)))
+-                       , IvoryExpr (r s2 ('Stored t))
++arrayCopyFromOffset :: ( ANat n, ANat m, KnownConstancy c
+                        , IvoryStore t
+                        )
+                     => Ref s1 ('Array n ('Stored t))
+-                    -> r s2 ('Array m ('Stored t))
++                    -> Pointer 'Valid c s2 ('Array m ('Stored t))
+```
+
+## Additions
+
+### Memory area attribute
+
+Allows to generate `__attribute__` to memory area definitions.
+For example:
+
+```haskell
+setAreaAttributes [ Section ".mySection" ]
+```
+
+Will generate
+```c
+extern bool test __attribute__(section(".mySection"));
+```
+
+### `SafeCast IDouble IFloat`
+
+Instance added, which allows to downcast
+from `IDouble` to `IFloat` safely, with
+just a loss of precision.
+
+### Allow for unticked `:->` type operator [#12](https://github.com/distrap/ivory/pull/12)
+
+Backwards compatible, all occurences of `':->` can be simply replaced with `:->`.
+
+---
+
+`ivory` uses [PVP Versioning][1].
+
+[1]: https://pvp.haskell.org
+

ivory/ivory.cabal

@@ -10,6 +10,7 @@ homepage:            http://ivorylang.org
 build-type:          Simple
 license:             BSD-3-Clause
 license-file:        LICENSE
+extra-doc-files:     CHANGELOG.md
 source-repository    this
   type:     git
   location: https://github.com/distrap/ivory