Edit rustc_middle::dep_graph module documentation #80325

pierwill · 2020-12-23T05:25:46Z

The first commit here moves the content to mod.rs, the second contains edits.

The section I've called "DepNode creation and 'inference'" appears to have some outdated material. (DepConstructor is a struct, not an enum.)

rust-highfive · 2020-12-23T05:25:49Z

r? @estebank

(rust-highfive has picked a reviewer for you, use r? to override)

jyn514 · 2020-12-23T23:48:05Z

r? @cjgillot

cjgillot · 2020-12-24T10:34:26Z

You may also want to edit the docs for rustc_query_system::dep_graph::dep_node, which are a copy-paste of those for rustc_middle::dep_graph::dep_node.

cjgillot · 2020-12-24T10:53:17Z

compiler/rustc_middle/src/dep_graph/mod.rs

@@ -28,8 +30,12 @@
 //!   could not be instantiated because the current compilation session
 //!   contained no `DefId` for thing that had been removed.
 //!
+//! ## `DepNode` creation and "inference"
+//!
+// Where is the `define_dep_nodes!()` macro?


The define_dep_nodes macro is defined in dep_node.rs.
It defines the DepKind enum, and DepConstructor.
DepNode is defined in rustc_query_system::dep_graph::dep_node.

cjgillot · 2020-12-24T10:55:09Z

compiler/rustc_middle/src/dep_graph/mod.rs

 //! `DepNode` definition happens in the `define_dep_nodes!()` macro. This macro
-//! defines the `DepKind` enum and a corresponding `DepConstructor` enum. The
+//! defines the `DepKind` enum and a corresponding [`DepConstructor`] enum. The


Drive-by: DepConstructor should really just be a mod, since all it does is provide a namespace for functions constructing DepNodes.

cjgillot · 2020-12-24T10:57:45Z

compiler/rustc_middle/src/dep_graph/mod.rs

@@ -50,6 +56,12 @@
 //! than a zeroed out fingerprint. More generally speaking, it relieves the


I am not sure the API is that restricted any more. There is an escape hatch DepNode::new_no_params which is used in non-incremental runs.

jyn514 · 2020-12-24T14:15:51Z

You may also want to edit the docs for rustc_query_system::dep_graph::dep_node, which are a copy-paste of those for rustc_middle::dep_graph::dep_node.

Maybe that module should link to rustc_middle instead? Or use doc = include_str! to make sure they're kept in sync?

bors · 2021-01-08T21:34:11Z

☔ The latest upstream changes (presumably #78452) made this pull request unmergeable. Please resolve the merge conflicts.

…erister Get rid of `DepConstructor` This removes fully 235 unused functions. Follow-up to rust-lang#80325 (comment). r? `@michaelwoerister` cc `@cjgillot`

…erister Get rid of `DepConstructor` This removes fully 235 unused functions. Follow-up to rust-lang#80325 (comment). r? ``@michaelwoerister`` cc ``@cjgillot``

This fixes the module-level docs not rendering. (As of this writing, the module description is missing from https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/dep_graph/index.html).

rust-log-analyzer · 2021-01-16T05:31:45Z

The job x86_64-gnu-tools failed! Check out the build log: (web) (plain)

Click to see the possible cause of the failure (guessed by this bot)

  SCCACHE_BUCKET: rust-lang-ci-sccache2
  TOOLSTATE_REPO: https://github.com/rust-lang-nursery/rust-toolstate
  CACHE_DOMAIN: ci-caches.rust-lang.org
  EXTRA_VARIABLES: {
 "CI_ONLY_WHEN_SUBMODULES_CHANGED": 1
##[endgroup]
adding extra environment variable CI_ONLY_WHEN_SUBMODULES_CHANGED
linux builder detected, using docker to run the build
##[group]Run src/ci/scripts/should-skip-this.sh
---
######################################################################## 100.0%
extracting /checkout/obj/build/cache/2020-11-19/rustfmt-nightly-x86_64-unknown-linux-gnu.tar.xz
    Updating crates.io index
    Updating git repository `https://github.com/rust-lang/cargo`
    Updating git repository `https://github.com/rust-lang/rustfmt`
error: the lock file /checkout/Cargo.lock needs to be updated but --locked was passed to prevent this
If you want to try to generate the lock file without accessing the network, use the --offline flag.
Build completed unsuccessfully in 0:00:41
make: *** [prepare] Error 1
Makefile:60: recipe for target 'prepare' failed
Command failed. Attempt 2/5:
Command failed. Attempt 2/5:
    Updating crates.io index
    Updating git repository `https://github.com/rust-lang/cargo`
    Updating git repository `https://github.com/rust-lang/rustfmt`
error: the lock file /checkout/Cargo.lock needs to be updated but --locked was passed to prevent this
If you want to try to generate the lock file without accessing the network, use the --offline flag.
Build completed unsuccessfully in 0:00:01
make: *** [prepare] Error 1
Makefile:60: recipe for target 'prepare' failed
Command failed. Attempt 3/5:
Command failed. Attempt 3/5:
    Updating crates.io index
    Updating git repository `https://github.com/rust-lang/cargo`
    Updating git repository `https://github.com/rust-lang/rustfmt`
error: the lock file /checkout/Cargo.lock needs to be updated but --locked was passed to prevent this
If you want to try to generate the lock file without accessing the network, use the --offline flag.
Build completed unsuccessfully in 0:00:00
make: *** [prepare] Error 1
Makefile:60: recipe for target 'prepare' failed
Command failed. Attempt 4/5:
Command failed. Attempt 4/5:
    Updating crates.io index
    Updating git repository `https://github.com/rust-lang/cargo`
    Updating git repository `https://github.com/rust-lang/rustfmt`
error: the lock file /checkout/Cargo.lock needs to be updated but --locked was passed to prevent this
If you want to try to generate the lock file without accessing the network, use the --offline flag.
Build completed unsuccessfully in 0:00:00
make: *** [prepare] Error 1
Makefile:60: recipe for target 'prepare' failed
Command failed. Attempt 5/5:
Command failed. Attempt 5/5:
    Updating crates.io index
    Updating git repository `https://github.com/rust-lang/cargo`
    Updating git repository `https://github.com/rust-lang/rustfmt`
error: the lock file /checkout/Cargo.lock needs to be updated but --locked was passed to prevent this
If you want to try to generate the lock file without accessing the network, use the --offline flag.
Build completed unsuccessfully in 0:00:00
make: *** [prepare] Error 1
Makefile:60: recipe for target 'prepare' failed
The command has failed after 5 attempts.

pierwill · 2021-01-16T05:31:56Z

Not at all sure I did this rebase correctly... 🤔

bors · 2021-01-17T02:37:40Z

☔ The latest upstream changes (presumably #81093) made this pull request unmergeable. Please resolve the merge conflicts.

rust-highfive assigned estebank Dec 23, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 23, 2020

cjgillot reviewed Dec 24, 2020

View reviewed changes

jyn514 added A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself A-query-system Area: The rustc query system (https://rustc-dev-guide.rust-lang.org/query.html) labels Dec 24, 2020

jyn514 added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 8, 2021

jyn514 mentioned this pull request Jan 8, 2021

Get rid of DepConstructor #80829

Merged

pierwill added 2 commits January 15, 2021 21:27

Move rustc_middle::dep_graph module docs to mod.rs

7065fc9

This fixes the module-level docs not rendering. (As of this writing, the module description is missing from https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/dep_graph/index.html).

Edit rustc_middle::dep_graph module-level documentation

aca67b2

pierwill closed this Jan 17, 2021

pierwill mentioned this pull request Jan 17, 2021

Edit rustc_middle::dep_graph module documentation #81130

Merged

pierwill deleted the rustcmiddle-depgraph-docs branch February 17, 2021 18:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Edit rustc_middle::dep_graph module documentation #80325

Edit rustc_middle::dep_graph module documentation #80325

pierwill commented Dec 23, 2020

rust-highfive commented Dec 23, 2020

jyn514 commented Dec 23, 2020

cjgillot commented Dec 24, 2020

cjgillot Dec 24, 2020

cjgillot Dec 24, 2020

cjgillot Dec 24, 2020

jyn514 commented Dec 24, 2020

bors commented Jan 8, 2021

rust-log-analyzer commented Jan 16, 2021

pierwill commented Jan 16, 2021

bors commented Jan 17, 2021

		@@ -50,6 +56,12 @@
		//! than a zeroed out fingerprint. More generally speaking, it relieves the

Edit rustc_middle::dep_graph module documentation #80325

Edit rustc_middle::dep_graph module documentation #80325

Conversation

pierwill commented Dec 23, 2020

rust-highfive commented Dec 23, 2020

jyn514 commented Dec 23, 2020

cjgillot commented Dec 24, 2020

cjgillot Dec 24, 2020

Choose a reason for hiding this comment

cjgillot Dec 24, 2020

Choose a reason for hiding this comment

cjgillot Dec 24, 2020

Choose a reason for hiding this comment

jyn514 commented Dec 24, 2020

bors commented Jan 8, 2021

rust-log-analyzer commented Jan 16, 2021

pierwill commented Jan 16, 2021

bors commented Jan 17, 2021