Skip to content

Commit

Permalink
Update changelog and upgrade doc
Browse files Browse the repository at this point in the history
  • Loading branch information
filmor committed Jun 6, 2024
1 parent d0816b7 commit ac4ef53
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
See [`UPGRADE.md`](./UPGRADE.md) for additional help when upgrading to newer
versions.

## [unreleased]

### Added

### Fixed

### Changed

- NIF implementations are now discovered automatically and the respective
argument of `rustler::init!` is ignored (#613)

### Removed


## [0.33.0] - 2024-05-29

### Added
Expand Down
14 changes: 10 additions & 4 deletions UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

This document is intended to simplify upgrading to newer versions by extending the changelog.

## 0.33 -> 0.34

1. NIF implementations are now discovered automatically, the respective argument
in the `rustler::init!` macro should be removed. If a NIF implementation
should not be exported, it must be disabled with a `#[cfg]` marker.

## 0.32 -> 0.33

The macro changes that where already carried out in version `0.22` are now
Expand Down Expand Up @@ -109,7 +115,7 @@ rustler::rustler_export_nifs! {
"Elixir.Math",
[
("add", 2, add),
("long_running_operation", 0, long_running_operation, SchedulerFlags::DirtyCpu)
("long_running_operation", 0, long_running_operation, SchedulerFlags::DirtyCpu)
],
None
}
Expand Down Expand Up @@ -184,9 +190,9 @@ NIF called `_long_running_operation`, which used to be declared prior to Rustler
rustler::rustler_export_nifs! {
"Elixir.SomeNif",
[
// Note that the function in Rust is long_running_operation, but the NIF is exported as
// _long_running_operation!
("_long_running_operation", 0, long_running_operation, SchedulerFlags::DirtyCpu)
// Note that the function in Rust is long_running_operation, but the NIF is exported as
// _long_running_operation!
("_long_running_operation", 0, long_running_operation, SchedulerFlags::DirtyCpu)
],
None
}
Expand Down

0 comments on commit ac4ef53

Please sign in to comment.