Skip to content

Commit 5deba22

Browse files
committed
Auto merge of #46278 - MaloJaffre:ci-compiler-docs, r=kennytm
Add compiler docs testing to CI. Fixes #47025. I don't know if `x86_64-gnu` is the right builder for this, but there seems to be time left on [Travis](https://travis-ci.org/rust-lang/rust/jobs/307488864). Remaining problems blocking this PR: - [x] broken links caused by rustdoc issues: - [x] `pub use self::Enum::...`: #46766 and #46767 (fixed by #47050, thanks @ollie27!) - [x] `impl Deref for DerefToStdType`: #32129 (ignored in linkchecker) - [x] `#[feature(decl_macro)]` and `use std::vec`: #47038 (ignored in linkchecker) - [x] `rustc_data_structures::sync::{Lrc, RwLock}` aliases `std` types: #32130 (ignored in linkchecker) - [x] markdown differences, in rust repository and in external crates, now failing the build with #46880 merged (all fixed) - [x] multiple crate updates needed: `rand`, `log`, `parking_lot_core`, `flate2` - [x] submodule updates needed to deduplicate dependencies: `rust-installer`, ~`cargo`~ (done by #47052) - [x] #44953 test broken by `log` update (removed, this can be controversial) - [x] Waiting `x86_64-gnu` build results ([done](https://travis-ci.org/rust-lang/rust/builds/323451069)) See individual commits for more details.
2 parents d5f2745 + 2449230 commit 5deba22

File tree

43 files changed

+255
-234
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+255
-234
lines changed

src/Cargo.lock

Lines changed: 78 additions & 78 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/ci/docker/x86_64-gnu/Dockerfile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,9 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
1616
COPY scripts/sccache.sh /scripts/
1717
RUN sh /scripts/sccache.sh
1818

19-
ENV RUST_CONFIGURE_ARGS --build=x86_64-unknown-linux-gnu --enable-sanitizers --enable-profiler
19+
ENV RUST_CONFIGURE_ARGS \
20+
--build=x86_64-unknown-linux-gnu \
21+
--enable-sanitizers \
22+
--enable-profiler \
23+
--enable-compiler-docs
2024
ENV SCRIPT python2.7 ../x.py test

src/libarena/lib.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,10 +148,11 @@ impl<T> TypedArena<T> {
148148
}
149149
}
150150

151-
/// Allocates a slice of objects that are copy into the `TypedArena`, returning a mutable
151+
/// Allocates a slice of objects that are copied into the `TypedArena`, returning a mutable
152152
/// reference to it. Will panic if passed a zero-sized types.
153153
///
154154
/// Panics:
155+
///
155156
/// - Zero-sized types
156157
/// - Zero-length slices
157158
#[inline]
@@ -369,6 +370,7 @@ impl DroplessArena {
369370
/// reference to it. Will panic if passed a zero-sized type.
370371
///
371372
/// Panics:
373+
///
372374
/// - Zero-sized types
373375
/// - Zero-length slices
374376
#[inline]

src/libgraphviz/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ pub enum LabelText<'a> {
306306
LabelStr(Cow<'a, str>),
307307

308308
/// This kind of label uses the graphviz label escString type:
309-
/// http://www.graphviz.org/content/attrs#kescString
309+
/// <http://www.graphviz.org/content/attrs#kescString>
310310
///
311311
/// Occurrences of backslashes (`\`) are not escaped; instead they
312312
/// are interpreted as initiating an escString escape sequence.
@@ -326,7 +326,7 @@ pub enum LabelText<'a> {
326326
}
327327

328328
/// The style for a node or edge.
329-
/// See http://www.graphviz.org/doc/info/attrs.html#k:style for descriptions.
329+
/// See <http://www.graphviz.org/doc/info/attrs.html#k:style> for descriptions.
330330
/// Note that some of these are not valid for edges.
331331
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
332332
pub enum Style {

src/librustc/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ byteorder = { version = "1.1", features = ["i128"]}
5454
# tl;dr; this is not needed to get `rustc` to compile, but if you remove it then
5555
# later crate stop compiling. If you can remove this and everything
5656
# compiles, then please feel free to do so!
57-
flate2 = "0.2"
57+
flate2 = "1.0"

src/librustc/dep_graph/dep_tracking_map.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ impl<M: DepTrackingMapConfig> MemoizationMap for RefCell<DepTrackingMap<M>> {
5656
/// map; and `CurrentTask` represents the current task when
5757
/// `memoize` is invoked.
5858
///
59-
/// **Important:* when `op` is invoked, the current task will be
59+
/// **Important:** when `op` is invoked, the current task will be
6060
/// switched to `Map(key)`. Therefore, if `op` makes use of any
6161
/// HIR nodes or shared state accessed through its closure
6262
/// environment, it must explicitly register a read of that

src/librustc/dep_graph/graph.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ impl DepGraph {
158158
/// what state they have access to. In particular, we want to
159159
/// prevent implicit 'leaks' of tracked state into the task (which
160160
/// could then be read without generating correct edges in the
161-
/// dep-graph -- see the [README] for more details on the
162-
/// dep-graph). To this end, the task function gets exactly two
161+
/// dep-graph -- see the module-level [README] for more details on
162+
/// the dep-graph). To this end, the task function gets exactly two
163163
/// pieces of state: the context `cx` and an argument `arg`. Both
164164
/// of these bits of state must be of some type that implements
165165
/// `DepGraphSafe` and hence does not leak.
@@ -178,7 +178,7 @@ impl DepGraph {
178178
/// - If you need 3+ arguments, use a tuple for the
179179
/// `arg` parameter.
180180
///
181-
/// [README]: README.md
181+
/// [README]: https://github.com/rust-lang/rust/blob/master/src/librustc/dep_graph/README.md
182182
pub fn with_task<C, A, R, HCX>(&self,
183183
key: DepNode,
184184
cx: C,

src/librustc/hir/def.rs

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,16 @@ pub enum Def {
7171
/// `base_def` is definition of resolved part of the
7272
/// path, `unresolved_segments` is the number of unresolved
7373
/// segments.
74-
/// module::Type::AssocX::AssocY::MethodOrAssocType
75-
/// ^~~~~~~~~~~~ ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
76-
/// base_def unresolved_segments = 3
7774
///
78-
/// <T as Trait>::AssocX::AssocY::MethodOrAssocType
79-
/// ^~~~~~~~~~~~~~ ^~~~~~~~~~~~~~~~~~~~~~~~~
80-
/// base_def unresolved_segments = 2
75+
/// ```text
76+
/// module::Type::AssocX::AssocY::MethodOrAssocType
77+
/// ^~~~~~~~~~~~ ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78+
/// base_def unresolved_segments = 3
79+
///
80+
/// <T as Trait>::AssocX::AssocY::MethodOrAssocType
81+
/// ^~~~~~~~~~~~~~ ^~~~~~~~~~~~~~~~~~~~~~~~~
82+
/// base_def unresolved_segments = 2
83+
/// ```
8184
#[derive(Copy, Clone, Debug)]
8285
pub struct PathResolution {
8386
base_def: Def,

src/librustc/hir/map/blocks.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ use syntax_pos::Span;
3333
/// and a body (as well as a NodeId, a span, etc).
3434
///
3535
/// More specifically, it is one of either:
36+
///
3637
/// - A function item,
3738
/// - A closure expr (i.e. an ExprClosure), or
3839
/// - The default implementation for a trait method.

src/librustc/hir/mod.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -588,7 +588,9 @@ pub type CrateConfig = HirVec<P<MetaItem>>;
588588
/// The top-level data structure that stores the entire contents of
589589
/// the crate currently being compiled.
590590
///
591-
/// For more details, see [the module-level README](README.md).
591+
/// For more details, see the module-level [README].
592+
///
593+
/// [README]: https://github.com/rust-lang/rust/blob/master/src/librustc/hir/README.md.
592594
#[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Debug)]
593595
pub struct Crate {
594596
pub module: Mod,

0 commit comments

Comments
 (0)