Comments (2)
Hi! I started to work on this. A couple of questions/uncertainties:
- I'm assuming it's a major-level change based on other violations like changing an established
repr
, although I couldn't find anything on the cargo semver page. for no_mangle/export_name specifically - Is it a violation when a non-public function changes export name? For example, in the example you linked, you can still access
im_secretly_public
even when it's not public in the Rust API. - Should this (these) lints proc when the export name of one function moves to a different function? For example,
#[no_mangle]
pub fn func1() {}
pub fn func2() {}
to
pub fn func1() {}
#[export_name = "func1"]
pub fn func2() {}
Thanks!
from cargo-semver-checks.
Great questions!
I'm assuming it's a major-level change based on other violations like changing an established
repr
, although I couldn't find anything on the cargo semver page. for no_mangle/export_name specifically
Yes, it's a major breaking change. The cargo semver reference isn't yet an exhaustive list of major changes, and we've had many situations where cargo-semver-checks work triggered additions to the reference or vice versa. I expect that trend will continue for some time :)
Is it a violation when a non-public function changes export name? For example, in the example you linked, you can still access
im_secretly_public
even when it's not public in the Rust API.
Yes! I believe we might actually have a lint for this already. It seems familiar and may have been added sometime in the last couple of months.
Should this (these) lints proc when the export name of one function moves to a different function? For example,
Great edge case! No, this should not trigger either lint.
In general, we want to trigger lints when we are certain there's a problem, so that we skew heavily away from false-positives which cause users to distrust the tool. In this edge case, the change may have been intentional and from an API/ABI perspective seems fine.
However, if the func2()
function e.g. takes a different number of arguments, then that should trigger a lint — I'm adding that plus related cases to the list.
from cargo-semver-checks.
Related Issues (20)
- Cargo semver checks ignores my lockfile HOT 8
- Running scripts on systems with bash version older than v4 causes errors HOT 3
- Notice if a run is going to be a no-op before generating rustdoc JSON
- False-positive "enum variant added on exhaustive enum" HOT 2
- Verbose runs should show which features were enabled in the crate versions being tested HOT 4
- Unable to enable dependency's features needed to build the crate HOT 6
- Build failure repro command may include `--features` flag without any features
- Support flags like `--color=always` and `--color=never`
- Improve error message when no library targets are found HOT 1
- Consider switching to `anstyle` for our terminal styling and color needs HOT 7
- Check if trait items with defaults may need special handling to avoid false-positives HOT 5
- Make the `make_new_lint.sh` script avoid merge conflicts when registering the new lints
- Consider either testing that lint file names match their `id` fields, or removing the field entirely.
- Add "Media coverage" section to the README, with relevant talks, podcasts, blog posts, etc.
- Support [term] configuration in Cargo config.toml for color and logging HOT 3
- `RustdocCommand` progress (when `silence` is `false`) does not respect configured `stderr`
- Check lints related to trait implementations for false-positives if the trait impl is `#[doc(hidden)]`
- Configuration methods do not have consistent naming HOT 3
- Refine lints about field and method removals to account for `Deref/DerefMut`
- `cargo semver-checks` takes much longer after upgrading to version 0.30.0 from 0.24.1 HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cargo-semver-checks.