Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rust documentation is outdated #912

Open
mr-cal opened this issue Nov 27, 2024 · 1 comment
Open

Rust documentation is outdated #912

mr-cal opened this issue Nov 27, 2024 · 1 comment
Labels
Documentation Improvements or additions to documentation Triaged

Comments

@mr-cal
Copy link
Contributor

mr-cal commented Nov 27, 2024

What needs to get done

The docs mention the rust-deps keyword which does not exist:

you can set rust-deps: ["rustc", "cargo"] and rust-channel: "none" in the part definition to override the default behaviour.

The docs should also be updated to reflect #903, which adds

Configures the following validation rules:
* 'rust-channel' is null or 'after: [rust-deps]': validate that cargo and rustc are installed
  and do not install rustup
* 'rust-channel' is defined: validate that rustup is installed
* 'rust-channel' and 'after: [rust-deps]' are defined: raise an error

Why it needs to get done

To have correct documentation

@mr-cal mr-cal added Documentation Improvements or additions to documentation Triaged labels Nov 27, 2024
Copy link

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3723.

This message was autogenerated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation Triaged
Projects
None yet
Development

No branches or pull requests

1 participant