Skip to content

Commit

Permalink
Update NEWS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
timholy authored Jul 24, 2024
1 parent 96c83db commit 710dc6c
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ This file contains information about major updates since 1.0.
## Version 3

Version 3 is a greatly slimmed repository, focusing just on those tools that are relevant for modern Julia development.
Users of tools that were removed should stick with SnoopCompile 2.x.
If you are still using old tools, you should stick with SnoopCompile 2.x.

Major changes:
- `@snoopi_deep` has been renamed `@snoop_inference`
- `@snoopr` has been renamed `@snoop_invalidations`.
- `@snoopl` has been renamed `@snoop_llvm`.
- The old `@snoopc` has been deleted. Its functionality was largely subsumed into `julia --trace-compile`.
-`@snoopi` has been deleted, as `@snoopi_deep` (now renamed to `@snoop_inference`) provides more comprehensive information and is available on all modern Julia versions.
-`@snoopi` has been deleted, as `@snoopi_deep` provided more comprehensive information and is available on all modern Julia versions.
- SnoopCompileBot was deleted in favor of [CompileBot](https://github.com/aminya/CompileBot.jl)
- SnoopPrecompile was deleted because it is now [PrecompileTools](https://github.com/JuliaLang/PrecompileTools.jl)

Additionally:
- `@snoopr` has been renamed `@snoop_invalidations`.
- `@snoopl` has been renamed `@snoop_llvm`.

- JET, Cthulhu, PrettyTables, and PyPlot are all integrated via package extensions. As a consequence, users now have to load them manually.

## Version 1.1

Expand Down

4 comments on commit 710dc6c

@timholy
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 subdir=SnoopCompileCore

@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/111694

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 SnoopCompileCore-v3.0.0 -m "<description of version>" 710dc6c1564dd76203d4fccd6f71403b53fea14e
git push origin SnoopCompileCore-v3.0.0

@timholy
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
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 updated: JuliaRegistries/General/111692

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 v3.0.0 -m "<description of version>" 710dc6c1564dd76203d4fccd6f71403b53fea14e
git push origin v3.0.0

Please sign in to comment.