-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
[[bin]] stanza of Cargo.toml not documented well #6913
Comments
Seems reasonable to have a short note to indicate that Just FYI, the documentation for installation is on the cargo install page, which explains where binaries are installed. I have a long-term goal to split up the manifest.md page into separate pages since it is somewhat disorganized. One of those pages would be "Cargo Targets" which would have detailed information about the different target kinds, and might do well to include this. |
I see, makes sense. Basically I am approaching this from a stand point of "I want to make a cli program people can use from their terminal, how can I do this so it's installed correctly?" Once I found out that if the |
Various doc updates This is a collection of documentation updates that have been in my todo list for a while. Each change is in a separate commit. The "features" chapter will probably get significant changes in the future, as it is pretty bare right now. Similarly the "workspace" chapter could probably use more examples. Closes #3062 Closes #3817 Closes #3971 Closes #4212 Closes #4438 Closes #4756 Closes #5822 Closes #6913 Closes #7055
Problem
In various crates on github, i have seen that the
[[bin]]
stanza in Cargo.toml can be used to specify executables that will be installed upon installing the crate, such asExcept, that stanza is not documented well on https://doc.rust-lang.org/cargo/reference/manifest.html it mentions it as specifying an executable, but not anything about where that executable is installed, or that it's even put on the PATH. I think this would be an important knowledge point because it's relevant to how executables can be used after installing a crate, instead of doing
cargo build
andcargo run
.Steps
Possible Solution(s)
Document the following
[bin]
stanza means and how it relates to executables getting put on the PATH.Notes
Output of
cargo version
: Not applicable , docs relatedThe text was updated successfully, but these errors were encountered: