Skip to content

Commit

Permalink
Omit src-links for items from extern macros
Browse files Browse the repository at this point in the history
If the span of a local item points into an external macro
its source-file will be bogus.
  • Loading branch information
mitaa committed Feb 12, 2016
1 parent c7640aa commit a31d633
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 5 deletions.
16 changes: 11 additions & 5 deletions src/librustdoc/html/render.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1501,11 +1501,17 @@ impl<'a> Item<'a> {
true, |component| {
path.push(component.to_string());
});
Some(format!("{root}src/{krate}/{path}.html#{href}",
root = self.cx.root_path,
krate = self.cx.layout.krate,
path = path.join("/"),
href = href))
// If the span points into an external macro the
// source-file will be bogus, i.e `<foo macros>`
if Path::new(&self.item.source.filename).is_file() {
Some(format!("{root}src/{krate}/{path}.html#{href}",
root = self.cx.root_path,
krate = self.cx.layout.krate,
path = path.join("/"),
href = href))
} else {
None
}

// If this item is not part of the local crate, then things get a little
// trickier. We don't actually know the span of the external item, but
Expand Down
14 changes: 14 additions & 0 deletions src/test/auxiliary/issue-26606-macro.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// Copyright 2016 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#[macro_export]
macro_rules! make_item (
($name: ident) => (pub const $name: usize = 42;)
);
21 changes: 21 additions & 0 deletions src/test/rustdoc/issue-26606.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// Copyright 2016 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// aux-build:issue-26606-macro.rs
// ignore-cross-compile
// build-aux-docs

// @has issue_26606_macro/macro.make_item!.html
#[macro_use]
extern crate issue_26606_macro;

// @has issue_26606/constant.FOO.html
// @!has - '//a/@href' '../src/'
make_item!(FOO);

0 comments on commit a31d633

Please sign in to comment.