Merge branch 'docs.rs-extern-version' into docs.rs

Author: onur

src/librustc/session/config.rs

@@ -1266,6 +1266,7 @@ pub fn rustc_optgroups() -> Vec<RustcOptGroup> {
     opts.extend_from_slice(&[
         opt::multi_s("", "extern", "Specify where an external rust library is located",
                      "NAME=PATH"),
+        opt::multi_s("", "extern-version", "", "NAME=CRATE_NAME,VERSION"),
         opt::opt_s("", "sysroot", "Override the system root", "PATH"),
         opt::multi("Z", "", "Set internal debugging options", "FLAG"),
         opt::opt_s("", "error-format",

src/librustdoc/html/render.rs

@@ -61,6 +61,7 @@ use rustc::middle::stability;
 use rustc::hir;
 use rustc::util::nodemap::{FxHashMap, FxHashSet};
 use rustc::session::config::nightly_options::is_nightly_build;
+use rustc::session::config::Externs;
 use rustc_data_structures::flock;
 
 use clean::{self, AttributesExt, GetDefId, SelfTy, Mutability};
@@ -429,6 +430,7 @@ pub fn derive_id(candidate: String) -> String {
 
 /// Generates the documentation for `crate` into the directory `dst`
 pub fn run(mut krate: clean::Crate,
+           extern_versions: Externs,
            external_html: &ExternalHtml,
            playground_url: Option<String>,
            dst: PathBuf,
@@ -539,8 +541,10 @@ pub fn run(mut krate: clean::Crate,
             Some(p) => p.to_path_buf(),
             None => PathBuf::new(),
         };
+        let extern_version = extern_versions.get(&e.name)
+            .and_then(|e| e.iter().last().map(|e| e.clone()));
         cache.extern_locations.insert(n, (e.name.clone(), src_root,
-                                          extern_location(e, &cx.dst)));
+                                          extern_location(e, extern_version, &cx.dst)));
 
         let did = DefId { krate: n, index: CRATE_DEF_INDEX };
         cache.external_paths.insert(did, (vec![e.name.to_string()], ItemType::Module));
@@ -864,13 +868,24 @@ fn clean_srcpath<F>(src_root: &Path, p: &Path, keep_filename: bool, mut f: F) wh
 
 /// Attempts to find where an external crate is located, given that we're
 /// rendering in to the specified source destination.
-fn extern_location(e: &clean::ExternalCrate, dst: &Path) -> ExternalLocation {
+fn extern_location(e: &clean::ExternalCrate, version: Option<String>, dst: &Path) -> ExternalLocation {
     // See if there's documentation generated into the local directory
     let local_location = dst.join(&e.name);
     if local_location.is_dir() {
         return Local;
     }
 
+    // version is only used in docs.rs' cargo
+    if let Some(version) = version {
+        let mut vs = version.split(",");
+        // FIXME: get rid of this stupid ifs
+        if let Some(name) = vs.next() {
+            if let Some(version) = vs.next() {
+                return Remote(format!("https://docs.rs/{}/{}/", name, version));
+            }
+        }
+    }
+
     // Failing that, see if there's an attribute specifying where to find this
     // external crate
     e.attrs.lists("doc")

src/librustdoc/lib.rs

@@ -139,6 +139,8 @@ pub fn opts() -> Vec<RustcOptGroup> {
                         "DIR")),
         stable(optmulti("", "cfg", "pass a --cfg to rustc", "")),
         stable(optmulti("", "extern", "pass an --extern to rustc", "NAME=PATH")),
+        stable(optmulti("", "extern-version", "pass an --extern-version to rustc",
+                        "NAME=CRATE_NAME,VERSION")),
         stable(optmulti("", "plugin-path", "directory to load plugins from", "DIR")),
         stable(optmulti("", "passes",
                         "list of passes to also run, you might want \
@@ -259,6 +261,14 @@ pub fn main_args(args: &[String]) -> isize {
         }
     };
 
+    let extern_versions = match parse_extern_versions(&matches) {
+        Ok(ex) => ex,
+        Err(err) => {
+            print_error(err);
+            return 1;
+        }
+    };
+
     let test_args = matches.opt_strs("test-args");
     let test_args: Vec<String> = test_args.iter()
                                           .flat_map(|s| s.split_whitespace())
@@ -326,7 +336,7 @@ pub fn main_args(args: &[String]) -> isize {
         info!("going to format");
         match output_format.as_ref().map(|s| &**s) {
             Some("html") | None => {
-                html::render::run(krate, &external_html, playground_url,
+                html::render::run(krate, extern_versions, &external_html, playground_url,
                                   output.unwrap_or(PathBuf::from("doc")),
                                   passes.into_iter().collect(),
                                   css_file_extension,
@@ -388,6 +398,23 @@ fn parse_externs(matches: &getopts::Matches) -> Result<Externs, String> {
     Ok(Externs::new(externs))
 }
 
+/// Extracts `--extern CRATE=CRATE_NAME,VERSION` arguments from `matches` and
+/// returns a map mapping crate names to their paths or else an
+/// error message.
+fn parse_extern_versions(matches: &getopts::Matches) -> Result<Externs, String> {
+    let mut externs = BTreeMap::new();
+    for arg in &matches.opt_strs("extern-version") {
+        let mut parts = arg.splitn(2, '=');
+        let name = parts.next().ok_or("--extern-version value must not be empty".to_string())?;
+        let location = parts.next()
+                                 .ok_or("--extern-version value must be of the format `foo=bar`"
+                                    .to_string())?;
+        let name = name.to_string();
+        externs.entry(name).or_insert_with(BTreeSet::new).insert(location.to_string());
+    }
+    Ok(Externs::new(externs))
+}
+
 /// Interprets the input file as a rust source file, passing it through the
 /// compiler all the way through the analysis passes. The rustdoc output is then
 /// generated from the cleaned AST of the crate.