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-gdb etc. wrapper documentation missing from --help, book, etc. #2532

Open
ijackson opened this issue Oct 21, 2020 · 1 comment
Open

Comments

@ijackson
Copy link
Contributor

Hi.

rustup (at leaast I assume it's rustup, since it seems like it's a hardlink to .cargo/bin/rustup) provided a wrapper rust-gdb on my PATH. This wrapper is convenient, so thanks.

However. I can't find any documentation about it. Some digging did find me the Rustup Book (although that is not installed by rustup!) which seems to have no mention of it. rustup man rust-gdb said no manual is available. rustup --help doesn't mention it. rust-gdb --help simply runs gdb and so prints gdb's help.

I suggest that:

  • Whenever rustup is called as rust-gdb or cargo or something, and the first argument is --help, it ought to print a message saying "hello I am actually rustup acting as a wrapper for foo" and explaining where to get more information.

  • There should be some documentation of these wrapper aliases somewhere. At the very leas there should be a list of them in the Rustup Book.

  • Ideally there should be a way to find out what the extra arguments or environment are without using strace. This could be important, for example, if a user wants to do something that the rustup wrapper doesn't have direct support for.

@kinnison
Copy link
Contributor

Taking your suggestions in order:

  1. I think Quick addition to --version to mention rustc #2465 gives us precedent to possibly intercept --help on the proxies to mention rustup at least. As such I'd be pleased if a PR showed up to do that.
  2. I agree that listing the proxies in the book makes sense. I've filed List proxies in the rustup book #2538 for this
  3. You can do rustup run .... which might be all you need. If that's not going to do what you need, then we can look at another solution. (e.g. rustup run stable env)

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

No branches or pull requests

2 participants