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

Small mistake in build instructions Note for packager #11557

Open
lukeflo opened this issue Aug 23, 2024 · 3 comments
Open

Small mistake in build instructions Note for packager #11557

lukeflo opened this issue Aug 23, 2024 · 3 comments
Labels
A-documentation Area: Documentation improvements C-bug Category: This is a bug

Comments

@lukeflo
Copy link

lukeflo commented Aug 23, 2024

I encountered a small flaw in the docs regarding building Helix from source. But since my Rust/Cargo knowledge is very limited, I'm not sure if it is a real bug, just a copy/paste typo, or my misunderstanding. Thus, no big bug report here, but a simple issue.

In the section Note to packagers under point to of the numbered list it is stated that the command cargo build --profile opt --locked --path helix-term should be executed to build Helix from source.

But if you run the command (after exporting the needed HELIX env variables, of course), yo'll get the following error:

cargo build --profile opt --locked --path helix-term
error: unexpected argument '--path' found

Usage: cargo build --profile <PROFILE-NAME> --locked

For more information, try '--help'.

Also the manpage, invoked with cargo help build, does not list --path as valid argument for the build command.

It might be a copy and paste error since in the initial section the command cargo install --path helix-term --locked is proposed for building Helix from source.

At least, AFAIK, building Helix with cargo build --profile opt --locked works just fine without the --path helix-term argument.

But as mentioned above, there might be another reason for the --path argument with the build command, I'm not aware of.

@the-mikedavis
Copy link
Member

Yep good catch, I believe that's just a copy/paste bug. Feel free to submit a PR. That document lives here: https://github.com/helix-editor/helix/blob/master/book/src/building-from-source.md

@the-mikedavis the-mikedavis added C-bug Category: This is a bug A-documentation Area: Documentation improvements labels Aug 26, 2024
@lukeflo
Copy link
Author

lukeflo commented Sep 6, 2024

Is that really worth a PR? Someone with write permissions only needs to delete the words --path helix-term from the line cargo build --profile opt --locked --path helix-term.

But if you prefer the PR way, I'll do it when I find some time.

@the-mikedavis
Copy link
Member

Only the author has unrestricted write access, for everything else we need a PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation improvements C-bug Category: This is a bug
Projects
None yet
Development

No branches or pull requests

2 participants