Skip to content

Add print-only url to rustup doc, fix #1288 #1324

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.

Sign up for GitHub

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

Closed
wants to merge 4 commits into from
Closed

Add print-only url to rustup doc, fix #1288 #1324

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8c5739f
Add print-only url to rustup doc, fix #1288
amar-laksh Jan 2, 2018
6af1c40
Add print-only url to rustup doc, fix #1288
amar-laksh Jan 2, 2018
fea9c7c
Merge branch 'doc-features' of https://github.com/amar-laksh/rustup.r…
amar-laksh Jan 2, 2018
b2b1645
REMOVED: EXTRA FILES
amar-laksh Jan 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/rustup-cli/rustup_mode.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,9 @@ pub fn cli() -> App<'static, 'static> {
.alias("docs")
.about("Open the documentation for the current toolchain")
.after_help(DOC_HELP)
.arg(Arg::with_name("print-only")
.long("print-only")
.help("The URL of the local Rust documentation"))
.arg(Arg::with_name("book")
.long("book")
.help("The Rust Programming Language book"))
Expand Down Expand Up @@ -780,6 +783,7 @@ fn override_remove(cfg: &Cfg, m: &ArgMatches) -> Result<()> {
}

fn doc(cfg: &Cfg, m: &ArgMatches) -> Result<()> {
let toolchain = try!(explicit_or_dir_toolchain(cfg, m));
let doc_url = if m.is_present("book") {
"book/index.html"
} else if m.is_present("std") {
Expand All @@ -788,6 +792,14 @@ fn doc(cfg: &Cfg, m: &ArgMatches) -> Result<()> {
"index.html"
};

if m.is_present("print-only") {
let path = toolchain.doc_path(doc_url);
match path {
Ok(v) => return Ok(println!("file:/{}", v.to_str().unwrap())),
Copy link
Member

Choose a reason for hiding this comment

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

This probably wants to be v.display().

Copy link
Author

Choose a reason for hiding this comment

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

Cleared the extra files, BTW v.display() for some reason doesn't provide the exact URL. So didn't change that part. Thanks.

Copy link
Contributor

Choose a reason for hiding this comment

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

This will produce a URL like file:/C:\Foo\bar on windows, or possibly something even stranger, can you update this to work on windows, and also add a test for this command.

Copy link
Author

Choose a reason for hiding this comment

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

Sure, I'll try to work it out.

Copy link
Author

@amar-laksh amar-laksh May 27, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

BTW, shouldn't the URL be just the URL with no platform-specific prefixes?
I mean just the 'C:\Foo\bar' or whatever the platform-specific URL is. @Diggsey ?

Copy link
Contributor

Choose a reason for hiding this comment

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

That is probably fine - at least on windows the browser is smart enough to turn a path into a file:/// URL.

Err(e) => return Err(From::from(e))
}
}

Ok(try!(cfg.open_docs_for_dir(&try!(utils::current_dir()), doc_url)))
}

Expand Down