Skip to content

Commit

Permalink
Finalize release notes.
Browse files Browse the repository at this point in the history
  • Loading branch information
@maleadt
maleadt committed Sep 10, 2024
1 parent b3ae5fc commit bb70260
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions NEWS.md
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
# LLVM.jl release notes


## In development: LLVM.jl v9.1
## LLVM.jl v9.1

The most important feature of this release is the addition of documentation, both in the
form of function docstrings, and an extensive manual.

As part of the documentation writing effort, many minor issues or areas for improvement were
identified, resulting in a large amount of minor, but breaking changes. For all of those,
deprecations are in place, so this release is not technically breaking. However, it is
strongly recommended to update your code to the new APIs as soon as possible, which can be
done by testing your code with `--depwarn=error`.
deprecations are in place. However, it is strongly recommended to update your code to the
new APIs as soon as possible, which can be done by testing your code with `--depwarn=error`.

Technically beaking changes:
Technically beaking changes (unlikely to affect any users):

- Metadata values attached using the `metadata` function [now need to
be](https://github.com/maleadt/LLVM.jl/pull/476) a subtype of `MDNode`. This behavior
Expand All @@ -23,7 +22,7 @@ Technically beaking changes:
The previous behavior resulted in the wrong context being used, which could lead to
crashes.

Minor changes:
Minor changes (breaking changes with deprecations):

- Branch instruction predicate getters [have been
renamed](https://github.com/maleadt/LLVM.jl/pull/473) from `predicate_int` and
Expand All @@ -47,6 +46,8 @@ New features:
enable extracting the address of a compiled function from an execution engine. This makes
it possible to simply `ccall` a compiled function without having to deal with
`GenericValue`s.
- `globalstring!` and `globalstring_ptr!` now support `addrspace` and `add_null` arguments,
similar to their C++ counterparts.


## LLVM.jl v9.0
Expand Down

2 comments on commit bb70260

@maleadt
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/114945

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v9.1.0 -m "<description of version>" bb70260d810d151a76ebf8ae45774ffea9928120
git push origin v9.1.0

Please sign in to comment.