Auto merge of #7576 - orium:add-back-support-for-browser-envvar, r=alexcrichton

Add back support for `BROWSER` envvar in `cargo doc --open`.

Fixes #6064.
Fixes #5965.

Author: bors

src/cargo/ops/cargo_doc.rs

@@ -1,10 +1,13 @@
 use crate::core::resolver::ResolveOpts;
-use crate::core::Workspace;
+use crate::core::{Shell, Workspace};
 use crate::ops;
 use crate::util::CargoResult;
 use failure::Fail;
 use opener;
 use std::collections::HashMap;
+use std::error::Error;
+use std::path::Path;
+use std::process::Command;
 
 /// Strongly typed options for the `cargo doc` command.
 #[derive(Debug)]
@@ -77,14 +80,33 @@ pub fn doc(ws: &Workspace<'_>, options: &DocOptions<'_>) -> CargoResult<()> {
         if path.exists() {
             let mut shell = options.compile_opts.config.shell();
             shell.status("Opening", path.display())?;
+            open_docs(&path, &mut shell)?;
+        }
+    }
+
+    Ok(())
+}
+
+fn open_docs(path: &Path, shell: &mut Shell) -> CargoResult<()> {
+    match std::env::var_os("BROWSER") {
+        Some(browser) => {
+            if let Err(e) = Command::new(&browser).arg(path).status() {
+                shell.warn(format!(
+                    "Couldn't open docs with {}: {}",
+                    browser.to_string_lossy(),
+                    e.description()
+                ))?;
+            }
+        }
+        None => {
             if let Err(e) = opener::open(&path) {
                 shell.warn(format!("Couldn't open docs: {}", e))?;
                 for cause in (&e as &dyn Fail).iter_chain() {
                     shell.warn(format!("Caused by:\n {}", cause))?;
                 }
             }
         }
-    }
+    };
 
     Ok(())
 }

src/doc/man/cargo-doc.adoc

@@ -21,7 +21,9 @@ is placed in `target/doc` in rustdoc's usual format.
 === Documentation Options
 
 *--open*::
-    Open the docs in a browser after building them.
+    Open the docs in a browser after building them. This will use your default
+    browser unless you define another one in the `BROWSER` environment
+    variable.
 
 *--no-deps*::
     Do not build documentation for dependencies.

src/doc/man/cargo-rustdoc.adoc

@@ -33,7 +33,9 @@ option.
 === Documentation Options
 
 *--open*::
-    Open the docs in a browser after building them.
+    Open the docs in a browser after building them. This will use your default
+    browser unless you define another one in the `BROWSER` environment
+    variable.
 
 === Package Selection
 

src/doc/man/generated/cargo-doc.html

@@ -28,7 +28,9 @@ <h3 id="cargo_doc_documentation_options">Documentation Options</h3>
 <dl>
 <dt class="hdlist1"><strong>--open</strong></dt>
 <dd>
-<p>Open the docs in a browser after building them.</p>
+<p>Open the docs in a browser after building them. This will use your default
+browser unless you define another one in the <code>BROWSER</code> environment
+variable.</p>
 </dd>
 <dt class="hdlist1"><strong>--no-deps</strong></dt>
 <dd>

src/doc/man/generated/cargo-rustdoc.html

@@ -45,7 +45,9 @@ <h3 id="cargo_rustdoc_documentation_options">Documentation Options</h3>
 <dl>
 <dt class="hdlist1"><strong>--open</strong></dt>
 <dd>
-<p>Open the docs in a browser after building them.</p>
+<p>Open the docs in a browser after building them. This will use your default
+browser unless you define another one in the <code>BROWSER</code> environment
+variable.</p>
 </dd>
 </dl>
 </div>

src/etc/man/cargo-doc.1

@@ -2,12 +2,12 @@
 .\"     Title: cargo-doc
 .\"    Author: [see the "AUTHOR(S)" section]
 .\" Generator: Asciidoctor 2.0.10
-.\"      Date: 2019-09-05
+.\"      Date: 2019-11-11
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "CARGO\-DOC" "1" "2019-09-05" "\ \&" "\ \&"
+.TH "CARGO\-DOC" "1" "2019-11-11" "\ \&" "\ \&"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0
@@ -41,7 +41,9 @@ is placed in \fBtarget/doc\fP in rustdoc\(cqs usual format.
 .sp
 \fB\-\-open\fP
 .RS 4
-Open the docs in a browser after building them.
+Open the docs in a browser after building them. This will use your default
+browser unless you define another one in the \fBBROWSER\fP environment
+variable.
 .RE
 .sp
 \fB\-\-no\-deps\fP

src/etc/man/cargo-help.1

@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: cargo-help
 .\"    Author: [see the "AUTHOR(S)" section]
-.\" Generator: Asciidoctor 2.0.8
-.\"      Date: 2019-06-07
+.\" Generator: Asciidoctor 2.0.10
+.\"      Date: 2019-06-03
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "CARGO\-HELP" "1" "2019-06-07" "\ \&" "\ \&"
+.TH "CARGO\-HELP" "1" "2019-06-03" "\ \&" "\ \&"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0

src/etc/man/cargo-init.1

@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: cargo-init
 .\"    Author: [see the "AUTHOR(S)" section]
-.\" Generator: Asciidoctor 2.0.8
-.\"      Date: 2019-06-07
+.\" Generator: Asciidoctor 2.0.10
+.\"      Date: 2019-06-03
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "CARGO\-INIT" "1" "2019-06-07" "\ \&" "\ \&"
+.TH "CARGO\-INIT" "1" "2019-06-03" "\ \&" "\ \&"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0

src/etc/man/cargo-install.1

@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: cargo-install
 .\"    Author: [see the "AUTHOR(S)" section]
-.\" Generator: Asciidoctor 2.0.8
-.\"      Date: 2019-07-15
+.\" Generator: Asciidoctor 2.0.10
+.\"      Date: 2019-10-09
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "CARGO\-INSTALL" "1" "2019-07-15" "\ \&" "\ \&"
+.TH "CARGO\-INSTALL" "1" "2019-10-09" "\ \&" "\ \&"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0

src/etc/man/cargo-login.1

@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: cargo-login
 .\"    Author: [see the "AUTHOR(S)" section]
-.\" Generator: Asciidoctor 2.0.8
-.\"      Date: 2019-06-07
+.\" Generator: Asciidoctor 2.0.10
+.\"      Date: 2019-06-03
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "CARGO\-LOGIN" "1" "2019-06-07" "\ \&" "\ \&"
+.TH "CARGO\-LOGIN" "1" "2019-06-03" "\ \&" "\ \&"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0