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

Documentation on how to use cargo lib to find target directory #3829

Closed
iddm opened this issue Mar 14, 2017 · 4 comments
Closed

Documentation on how to use cargo lib to find target directory #3829

iddm opened this issue Mar 14, 2017 · 4 comments
Labels
A-documenting-cargo-itself Area: Cargo's documentation C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted`

Comments

@iddm
Copy link

iddm commented Mar 14, 2017

I want to create a external cargo subcommand. I've checked few existing external subcommands and they are using cargo, but very old one. I have tried to find any information about how can I use the cargo crate for, for example, finding target directory, but I was unable to find such information anywhere. After that I decided to find any information about the cargo crate but I could not: it does not exist it seems.

A few questions:

  1. Why is it so?
  2. How to find any information about it then?
@alexcrichton
Copy link
Member

Thanks for the report! The crate isn't really intended to work well with newbies unfortunately right now in the sense that little-to-no effort has been put in to make it such (not that it can't be).

PRs with docs however would be most welcome!

@carols10cents carols10cents changed the title Cargo crate seems to be unusable for newbies without documentation Documentation on how to use cargo lib to find target directory Oct 2, 2017
@carols10cents carols10cents added A-documenting-cargo-itself Area: Cargo's documentation C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` labels Oct 2, 2017
@dwijnand
Copy link
Member

Does this mean Cargo's programmatic API is meant to be backwards compatible?

@dwijnand
Copy link
Member

Does this mean Cargo's programmatic API is meant to be backwards compatible?

From #5955 (comment) and #5839 (comment), no, it's not.

@weihanglo
Copy link
Member

Going to close this since I don't think we need an issue to track a specific API item.

For the past months, the Cargo team has been working on improving the API documentation. We moved parts of contributors docs to rustdoc (e.g., #11662, #11809, #11850), and added more intra-doc links (e.g., #11711, #12133).

For my personal interest, I'd like to see more high-level concepts get documented, such as Source and Resolver.

Thank you for the report anyway!

@weihanglo weihanglo closed this as not planned Won't fix, can't repro, duplicate, stale May 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documenting-cargo-itself Area: Cargo's documentation C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted`
Projects
None yet
Development

No branches or pull requests

5 participants