Document all public items in `rustc_incremental` #90407

pierwill · 2021-10-29T17:58:27Z

Also:

Review and edit current docs
Enforce documentation for the module.

rust-highfive · 2021-10-29T17:58:30Z

r? @cjgillot

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

compiler/rustc_incremental/src/persist/fs.rs

compiler/rustc_incremental/src/persist/load.rs

compiler/rustc_incremental/src/persist/save.rs

compiler/rustc_incremental/src/persist/fs.rs

pierwill · 2021-10-29T18:07:36Z

Thank you, @r00ster91! I forgot the recommend style.

bjorn3 · 2021-10-29T18:39:42Z

compiler/rustc_incremental/src/persist/fs.rs

 pub fn staging_dep_graph_path(sess: &Session) -> PathBuf {
    in_incr_comp_dir_sess(sess, STAGING_DEP_GRAPH_FILENAME)
 }
+/// Returns the path to the dependency graph directory.
 pub fn dep_graph_path_from(incr_comp_session_dir: &Path) -> PathBuf {
    in_incr_comp_dir(incr_comp_session_dir, DEP_GRAPH_FILENAME)
 }


What is the difference between the return values of these functions? Can you expand on this in the doc comments?

I removed references to "the current session". The signature tells the story, here, it seems.

How do these function docs look to you, @cjgillot?

https://github.com/rust-lang/rust/blob/cac82a28bd7a780b86a581648685f439a76153ee/compiler/rustc_incremental/src/persist/fs.rs#L136-L155

Can you expand a bit on what those path represent? I mean:

what are stored in all these files?

the difference between dep-graph and staging dep-graph?

what are work products?

I'm not sure how to describe the query cache here.

bjorn3 · 2021-10-29T18:41:10Z

compiler/rustc_incremental/src/persist/fs.rs

@@ -664,6 +676,7 @@ fn is_old_enough_to_be_collected(timestamp: SystemTime) -> bool {
    timestamp < SystemTime::now() - Duration::from_secs(10)
 }

+/// Runs garbage collection for the current session.


It garbage collects all incremental session directories except the current session, right?

Good question. I'll double check.

The garbage collection logic is complex enough here that I wouldn't feel comfortable discussing its behavior in the public doc comment without input from someone familiar with this code. (Although I suspect you are right!)

cjgillot · 2021-11-06T17:55:43Z

compiler/rustc_incremental/src/persist/fs.rs

 pub fn staging_dep_graph_path(sess: &Session) -> PathBuf {
    in_incr_comp_dir_sess(sess, STAGING_DEP_GRAPH_FILENAME)
 }
+/// Returns the path to the dependency graph directory.
 pub fn dep_graph_path_from(incr_comp_session_dir: &Path) -> PathBuf {
    in_incr_comp_dir(incr_comp_session_dir, DEP_GRAPH_FILENAME)
 }


Can you expand a bit on what those path represent? I mean:

what are stored in all these files?

the difference between dep-graph and staging dep-graph?

what are work products?

cjgillot · 2021-11-06T17:59:04Z

compiler/rustc_incremental/src/persist/fs.rs

 pub fn staging_dep_graph_path(sess: &Session) -> PathBuf {
    in_incr_comp_dir_sess(sess, STAGING_DEP_GRAPH_FILENAME)
 }
+/// Returns the path to the dependency graph for a given session directory.
 pub fn dep_graph_path_from(incr_comp_session_dir: &Path) -> PathBuf {


This function is only used once, with the current session's directory. Is there a reason to keep it, or should it be replaced by dep_graph_path?

If it's inlined, DEP_GRAPH_FILENAME has to be made public. I think it makes sense to have all these in one place, even if the function is only used once.

I don't mean inlining it. I mean using dep_graph_path instead.

compiler/rustc_incremental/src/persist/load.rs

compiler/rustc_incremental/src/persist/save.rs

cjgillot · 2021-11-06T18:11:43Z

compiler/rustc_incremental/src/persist/work_product.rs

@@ -40,6 +43,7 @@ pub fn copy_cgu_workproduct_to_incr_comp_cache_dir(
    Some((work_product_id, work_product))
 }

+/// Removes files for a given work product.
 pub fn delete_workproduct_files(sess: &Session, work_product: &WorkProduct) {


This function is never used outside the crate.

compiler/rustc_incremental/src/persist/work_product.rs

bors · 2021-11-12T07:59:03Z

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

bors · 2021-11-18T23:54:05Z

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

cjgillot · 2021-11-20T11:04:46Z

r=me after rebase. Thanks @pierwill !

pierwill · 2021-12-06T15:47:21Z

r=me after rebase. Thanks @pierwill !

ping @cjgillot :)

cjgillot · 2021-12-06T19:48:27Z

@bors r+ rollup

bors · 2021-12-06T19:48:29Z

📌 Commit fa054cf has been approved by cjgillot

…s, r=cjgillot Document all public items in `rustc_incremental` Also: - Review and edit current docs - Enforce documentation for the module.

matthiaskrgr · 2021-12-07T10:04:15Z

@bors r-
failed in rollup
#91621 (comment)

pierwill · 2021-12-07T15:31:29Z

@bors r- failed in rollup #91621 (comment)

Looking at this now.

Also: - Review and edit current docs - Enforce documentation for crate Co-authored-by: r00ster <r00ster91@protonmail.com> Co-authored-by: Camille Gillot <gillot.camille@gmail.com>

pierwill · 2021-12-07T16:12:21Z

This should be ready now. @matthiaskrgr

pierwill · 2021-12-07T16:12:36Z

@rustbot ready

cjgillot · 2021-12-09T17:02:08Z

@bors r+ rollup

bors · 2021-12-09T17:02:10Z

📌 Commit 41f7692 has been approved by cjgillot

…s, r=cjgillot Document all public items in `rustc_incremental` Also: - Review and edit current docs - Enforce documentation for the module.

…askrgr Rollup of 10 pull requests Successful merges: - rust-lang#90407 (Document all public items in `rustc_incremental`) - rust-lang#90897 (Fix incorrect stability attributes) - rust-lang#91105 (Fix method name reference in stream documentation) - rust-lang#91325 (adjust const_eval_select documentation) - rust-lang#91470 (code-cov: generate dead functions with private/default linkage) - rust-lang#91482 (Update documentation to use `from()` to initialize `HashMap`s and `BTreeMap`s) - rust-lang#91524 (Fix Vec::extend_from_slice docs) - rust-lang#91575 (Fix ICE on format string of macro with secondary-label) - rust-lang#91625 (Remove redundant [..]s) - rust-lang#91646 (Fix documentation for `core::ready::Ready`) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

rust-highfive assigned cjgillot Oct 29, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 29, 2021

pierwill commented Oct 29, 2021

View reviewed changes

compiler/rustc_incremental/src/persist/fs.rs Outdated Show resolved Hide resolved

wooster0 suggested changes Oct 29, 2021

View reviewed changes

pierwill force-pushed the edit-rustc-incremental-docs branch from 3e02dc8 to 3ee4b6b Compare October 29, 2021 18:08

bjorn3 reviewed Oct 29, 2021

View reviewed changes

pierwill force-pushed the edit-rustc-incremental-docs branch from cac82a2 to cc9c544 Compare October 29, 2021 19:54

pierwill requested review from cjgillot and bjorn3 October 31, 2021 18:59

bjorn3 removed their request for review November 1, 2021 14:18

pierwill requested a review from bjorn3 November 1, 2021 18:50

pierwill force-pushed the edit-rustc-incremental-docs branch from d2f3a3a to 1eea8ac Compare November 2, 2021 16:13

cjgillot reviewed Nov 6, 2021

View reviewed changes

pierwill mentioned this pull request Nov 6, 2021

Consider removing rustc_incremental::persist::fs::dep_graph_path_from #90658

Closed

pierwill requested a review from cjgillot November 6, 2021 20:56

apiraino added the T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. label Nov 11, 2021

pierwill force-pushed the edit-rustc-incremental-docs branch from 3941f5f to a358d3b Compare November 12, 2021 15:17

cjgillot 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 Nov 27, 2021

pierwill force-pushed the edit-rustc-incremental-docs branch 2 times, most recently from 3602c51 to fa054cf Compare December 6, 2021 15:47

matthiaskrgr mentioned this pull request Dec 7, 2021

Rollup of 9 pull requests #91621

Closed

bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Dec 7, 2021

Document all public items in rustc_incremental

41f7692

Also: - Review and edit current docs - Enforce documentation for crate Co-authored-by: r00ster <r00ster91@protonmail.com> Co-authored-by: Camille Gillot <gillot.camille@gmail.com>

pierwill force-pushed the edit-rustc-incremental-docs branch from fa054cf to 41f7692 Compare December 7, 2021 16:11

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

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 9, 2021

matthiaskrgr mentioned this pull request Dec 9, 2021

Rollup of 8 pull requests #91723

Closed

matthiaskrgr mentioned this pull request Dec 10, 2021

Rollup of 12 pull requests #91726

Closed

matthiaskrgr mentioned this pull request Dec 10, 2021

Rollup of 22 pull requests #91756

Closed

matthiaskrgr mentioned this pull request Dec 10, 2021

Rollup of 10 pull requests #91760

Merged

bors merged commit 71c1d56 into rust-lang:master Dec 11, 2021

rustbot added this to the 1.59.0 milestone Dec 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document all public items in `rustc_incremental` #90407

Document all public items in `rustc_incremental` #90407

pierwill commented Oct 29, 2021

rust-highfive commented Oct 29, 2021

pierwill commented Oct 29, 2021 •

edited

Loading

bjorn3 Oct 29, 2021

pierwill Oct 29, 2021 •

edited

Loading

cjgillot Nov 6, 2021

pierwill Nov 6, 2021

bjorn3 Oct 29, 2021

pierwill Oct 29, 2021

pierwill Oct 29, 2021 •

edited

Loading

cjgillot Nov 6, 2021

cjgillot Nov 6, 2021

pierwill Nov 6, 2021

cjgillot Nov 6, 2021

cjgillot Nov 6, 2021

bors commented Nov 12, 2021

bors commented Nov 18, 2021

cjgillot commented Nov 20, 2021

pierwill commented Dec 6, 2021

cjgillot commented Dec 6, 2021

bors commented Dec 6, 2021

matthiaskrgr commented Dec 7, 2021

pierwill commented Dec 7, 2021

pierwill commented Dec 7, 2021

pierwill commented Dec 7, 2021

cjgillot commented Dec 9, 2021

bors commented Dec 9, 2021

Document all public items in rustc_incremental #90407

Document all public items in rustc_incremental #90407

Conversation

pierwill commented Oct 29, 2021

rust-highfive commented Oct 29, 2021

pierwill commented Oct 29, 2021 • edited Loading

Choose a reason for hiding this comment

pierwill Oct 29, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pierwill Oct 29, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bors commented Nov 12, 2021

bors commented Nov 18, 2021

cjgillot commented Nov 20, 2021

pierwill commented Dec 6, 2021

cjgillot commented Dec 6, 2021

bors commented Dec 6, 2021

matthiaskrgr commented Dec 7, 2021

pierwill commented Dec 7, 2021

pierwill commented Dec 7, 2021

pierwill commented Dec 7, 2021

cjgillot commented Dec 9, 2021

bors commented Dec 9, 2021

Document all public items in `rustc_incremental` #90407

Document all public items in `rustc_incremental` #90407

pierwill commented Oct 29, 2021 •

edited

Loading

pierwill Oct 29, 2021 •

edited

Loading

pierwill Oct 29, 2021 •

edited

Loading