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_is_available: exit showing the documentation #932

Open
wants to merge 1 commit into
base: rust
Choose a base branch
from

Conversation

aliceinwire
Copy link

Signed-off-by: Alice Ferrazzi [email protected]

@ojeda
Copy link
Member

ojeda commented Dec 1, 2022

Thanks for this!

Related patch: https://lore.kernel.org/rust-for-linux/[email protected]/ where Olof suggested giving explicit suggestions, while I recommended linking to the documentation instead as you do here -- so not sure if you saw that patch or you had the same thought as I did.

Either way, I think it is fine if this helps others! Maybe we could simplify to a single line if it fits, e.g.

Please refer to Documentation/rust/quick-start.rst

The URL is nice to click on many terminals, though the local resource is also typically easy to open too; plus it is for sure for the version one is attempting to compile (i.e. requirements or instructions could change, the document itself could move...) and goes in line with what other comments in Makefiles do (though those are just comments, i.e. not displayed).

@aliceinwire
Copy link
Author

Thanks for this!

Related patch: https://lore.kernel.org/rust-for-linux/[email protected]/ where Olof suggested giving explicit suggestions, while I recommended linking to the documentation instead as you do here -- so not sure if you saw that patch or you had the same thought as I did.

Thanks you, no I was not aware of that patch. Thanks for linking it.

Either way, I think it is fine if this helps others! Maybe we could simplify to a single line if it fits, e.g.

Please refer to Documentation/rust/quick-start.rst

The URL is nice to click on many terminals, though the local resource is also typically easy to open too; plus it is for sure for the version one is attempting to compile (i.e. requirements or instructions could change, the document itself could move...) and goes in line with what other comments in Makefiles do (though those are just comments, i.e. not displayed).

I personally open links from terminal, so I was suggesting to add it as a link but I actually prefer your suggestion.
Updated the patch with your suggestion.

Thanks,
Alice

scripts/rust_is_available.sh Outdated Show resolved Hide resolved
exit function providing a documentation link

Signed-off-by: Alice Ferrazzi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants