Remove properly tracked config file from .gitignore & add support for skipping of link-checking #2023

marxin · 2024-07-24T11:55:20Z

The file is part of the git history and is a configuration file.

Fixes: #2018

camelid · 2024-07-26T22:35:46Z

I think the reason this is ignored is that we often want to change book.toml locally to turn off link-checking. I'm not sure it makes sense to remove it from the gitignore unless there's another way to disable link-checking locally.

marxin · 2024-07-27T07:40:26Z

Sure, that makes sense and I've just added the support. What do you think about it now?

marxin · 2024-08-14T08:27:09Z

@camelid May I please ping this?

marxin · 2024-12-29T19:20:48Z

@camelid: A gentle ping.

The file is part of the git history and is a configuration file. Fixes: rust-lang#2018

camelid

Thanks! This is a much better approach than our old approach of just commenting out the config. Just left a comment about something that seems wrong.

ci/linkcheck.sh

Update books ## rust-lang/book 13 commits in ad2011d3bcad9f152d034faf7635c22506839d58..04d06dfe541607e6419f3d028c3f9b245f3be4d9 2024-12-20 22:44:11 UTC to 2024-12-16 18:18:21 UTC - Update section name (rust-lang/book#4175) - Update text to reflect the change from '&str' to 'char' in example (rust-lang/book#4173) - Update figure number in text and file name (rust-lang/book#4172) - Fix chapter number (rust-lang/book#4171) - Delete unused reference (rust-lang/book#4170) - Remove orphaned half-sentence (rust-lang/book#4169) - Fix chapter number (rust-lang/book#4168) - A better phrasing for generic methods. (rust-lang/book#3428) - Fix minor grammatical error (rust-lang/book#4098) - Update appendix-06-translation.md to add another Chinese translation. (rust-lang/book#3608) - Change Korean translation repo to newer (rust-lang/book#3625) - Clarify/improve readability in Ch. 02 discussion of `Result` variants (rust-lang/book#4167) - Ch. 20: conclude §01 with a reference to the Rustonomicon (rust-lang/book#4166) ## rust-lang/nomicon 1 commits in 97e84a38c94bf9362b11284c20b2cb4adaa1e868..7ef05b9777c94836bc92f50f23e6e00981521a89 2024-12-30 10:38:10 UTC to 2024-12-30 10:38:10 UTC - Fix URL fragment to MutexGuard's negative impl of Send (rust-lang/nomicon#472) ## rust-lang/reference 3 commits in 9f41bc11342d46544ae0732caf14ec0bcaf27376..acd6794e712d5e2ef6f5c84fb95688d32a69b816 2024-12-18 23:04:30 +0000 to 2024-12-30 22:12:57 +0000 - Revert "`coverage` attribute" (rust-lang/reference#1706) - Document Rust 2024 match ergonomics reservations (rust-lang/reference#1702) - Add documentation for `#[diagnostic::do_not_recommend]` (rust-lang/reference#1663) ## rust-lang/edition-guide 5 commits in bc4ce51e1d4dacb9350a92e95f6159a42de2f8c6..d56e0f3a0656b7702ca466d4b191e16c28262b82 2024-12-18 05:34:59 +0000 to 2024-12-31 20:04:52 +0000 - 2024: Document rustfmt overflow_delimited_expr (rust-lang/edition-guide#352) - 2024: Document rustfmt fixes (rust-lang/edition-guide#351) - Update the transitioning steps (rust-lang/edition-guide#350) - Revert "2024: Assignment operator RHS indentation" (rust-lang/edition-guide#343) - Revert "2024: Add chapter on single-line `where` clauses" (rust-lang/edition-guide#344) ## rust-lang/rust-by-example 1 commits in 76406337f4131253443aea0ed7e7f451b464117c..093397535b48ae13ec76bc526b7e6eb8c096a85c 2024-12-18 17:29:56 UTC to 2024-12-18 17:29:56 UTC - Mention that you're not allowed to partially move Drop types (rust-lang/rust-by-example#1902) ## rust-lang/rustc-dev-guide 18 commits in 7f7ba48f04abc2ad25e52f30b5e2bffa286b019f..ad93c5f1c49f2aeb45f7a4954017b1e607df9f5e 2024-12-30 09:22:22 UTC to 2024-12-17 17:00:38 UTC - Opt into, rather than out of, linkcheck (rust-lang/rustc-dev-guide#2180) - Remove stale implementation details of coverage instrumentation (rust-lang/rustc-dev-guide#2179) - Remove properly tracked config file from .gitignore & add support for skipping of link-checking (rust-lang/rustc-dev-guide#2023) - Add a couple of linkcheck exceptions: (rust-lang/rustc-dev-guide#2120) - Add missing link for [Node] (rust-lang/rustc-dev-guide#2177) - Fix 403 received for HEAD request (rust-lang/rustc-dev-guide#2176) - Start using mdbook-linkcheck2 (rust-lang/rustc-dev-guide#2103) - Document `x test --no-capture` (rust-lang/rustc-dev-guide#2174) - Remove the `-test` suffix from normalize directives (rust-lang/rustc-dev-guide#2172) - Rework the driver docs (rust-lang/rustc-dev-guide#2162) - Document `forbid-output` for UI tests (rust-lang/rustc-dev-guide#2171) - completions: Zsh is now supported (rust-lang/rustc-dev-guide#2173) - region-outlives propagation (rust-lang/rustc-dev-guide#2169) - compiletest: Document the `--debugger` flag (rust-lang/rustc-dev-guide#2170) - document the public ci dashboard (rust-lang/rustc-dev-guide#2167) - Fix trivial typo of "query-fied" (rust-lang/rustc-dev-guide#2165) - Fix some typos (rust-lang/rustc-dev-guide#2166) - Add suggestion for `--keep-stage 0` (rust-lang/rustc-dev-guide#2164)

… skipping of link-checking (rust-lang#2023) * Remove properly tracked config file from .gitignore The file is part of the git history and is a configuration file. Fixes: rust-lang#2018 * Add env. variable support * Refactoring * Really skip linkcheck if requested

marxin force-pushed the book.toml-remove-from-gitignores branch from af3a314 to 5b5c220 Compare July 27, 2024 07:38

marxin changed the title ~~Remove properly tracked config file from .gitignore~~ Remove properly tracked config file from .gitignore & add support for skipping of link-checking Jul 27, 2024

marxin force-pushed the book.toml-remove-from-gitignores branch from 5b5c220 to 9667f99 Compare July 27, 2024 12:54

jieyouxu added the S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content label Oct 8, 2024

jieyouxu added A-meta Area: meta, about rustc or rustc-dev-guide itself C-CI Category: CI for this repo A-linkcheck Area: linkcheck WG-rustc-dev-guide Working group: rustc-dev-guide labels Nov 4, 2024

marxin added 3 commits December 29, 2024 20:21

Remove properly tracked config file from .gitignore

8a69351

The file is part of the git history and is a configuration file. Fixes: rust-lang#2018

Add env. variable support

f5e11cd

Refactoring

7c88005

marxin force-pushed the book.toml-remove-from-gitignores branch from 9667f99 to 7c88005 Compare December 29, 2024 19:23

camelid requested changes Dec 29, 2024

View reviewed changes

ci/linkcheck.sh Outdated Show resolved Hide resolved

camelid added S-waiting-on-author Status: this PR is waiting for additional action by the OP and removed S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content labels Dec 29, 2024

Really skip linkcheck if requested

ed761c7

marxin requested a review from camelid December 29, 2024 21:15

camelid approved these changes Dec 29, 2024

View reviewed changes

camelid merged commit 04a5a98 into rust-lang:master Dec 29, 2024
1 check passed

marxin deleted the book.toml-remove-from-gitignores branch December 29, 2024 21:25

rustbot mentioned this pull request Dec 30, 2024

Update books rust-lang/rust#134926

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove properly tracked config file from .gitignore & add support for skipping of link-checking #2023

Remove properly tracked config file from .gitignore & add support for skipping of link-checking #2023

marxin commented Jul 24, 2024

camelid commented Jul 26, 2024

marxin commented Jul 27, 2024

marxin commented Aug 14, 2024

marxin commented Dec 29, 2024

camelid left a comment

Remove properly tracked config file from .gitignore & add support for skipping of link-checking #2023

Remove properly tracked config file from .gitignore & add support for skipping of link-checking #2023

Conversation

marxin commented Jul 24, 2024

camelid commented Jul 26, 2024

marxin commented Jul 27, 2024

marxin commented Aug 14, 2024

marxin commented Dec 29, 2024

camelid left a comment

Choose a reason for hiding this comment