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

[docs] add note about cargo feature flags #1137

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

Conversation

msandy
Copy link

@msandy msandy commented Nov 10, 2022

Fix for issue #1131

@eladyn
Copy link
Member

eladyn commented Nov 12, 2022

Thank you! I just realized that maybe the real problem is rather that the documentation is misleading by saying that

To install the resulting binary, run

cargo install --path . --locked

because cargo install doesn't actually install the built binary, but rather compiles it first and then installs it to the correct location. Maybe we could change that to better reflect the actual situation? Would that have solved your problem as well?

Copy link
Contributor

@Plecra Plecra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documenting this as explicitly diverging from make conventions sounds good to me :) It'd be great to make further changes along the lines you're describing @eladyn

@slondr
Copy link
Member

slondr commented Dec 20, 2022

Seconding eladyn's point here — the docs are straight up wrong with the "resulting" part, and would probably be better served by making the cargo install section more prominent/higher in the section as to not imply it's part of a different installation process. That should help solve the problem of folks arriving in the repo just trying to install the software as fast as possible.

As an aside, I looked up the current 0.3.4 rollout on repology, and I want to give a special shout-out to Arch, Funtoo, and Void for being the only three distro [families] that are already shipping the new version to users :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants