about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide/README.md
AgeCommit message (Collapse)AuthorLines
2025-07-04Document `rustc-josh-sync`Jakub Beránek-19/+1
2025-07-04Remove `josh-sync` tooling and update READMEJakub Beránek-30/+5
2025-05-01add rdg push git config entry for git protocol pushersTshepang Mbambo-0/+10
2025-04-19toolchain version does not need to be specifiedTshepang Mbambo-2/+2
- Rust backcompat removes the need to specify the version here - Using these commands can result in a needless toolchain getting downloaded, like in the case where user only has Nightly installed
2025-04-19readme: be copy-paste friendlyTshepang Mbambo-7/+7
2025-03-13Document `fetch.prunetags = true` gotcha during rustc-pull许杰友 Jieyou Xu (Joe)-0/+13
2025-01-20docs: document how to install a suitable `josh-proxy` locally许杰友 Jieyou Xu (Joe)-0/+7
Co-authored-by: Boxy <rust@boxyuwu.dev>
2025-01-05Add tooling for performing Josh synces (#2183)Jakub Beránek-43/+18
2024-12-30Opt into, rather than out of, linkcheck (#2180)Noah Lev-5/+7
This makes it less of a hassle to render the book locally.
2024-12-29Remove properly tracked config file from .gitignore & add support for ↵Martin Liška-3/+8
skipping of link-checking (#2023) * Remove properly tracked config file from .gitignore The file is part of the git history and is a configuration file. Fixes: #2018 * Add env. variable support * Refactoring * Really skip linkcheck if requested
2024-12-28Start using mdbook-linkcheck2 (#2103)Martin Liška-2/+2
2024-03-30Delete length check (#1952)Nilstrieb-19/+0
It's super annoying to be forced to use this bad convention, and apparently everyone agrees. The only reason no improvements have been done is because those were blocked on writing a better checker. I strongly believe that no checker is better than a bad checker, so let's just delete it in the meantime. I kindly asked anyone who sees this to complain about overly long sentences in review in the future, I think we can make this turn out fine.
2023-06-30Change `./x.py` into `./x`sslime336-1/+1
2023-04-09Various improvements to `check_line_lengths.sh` (#1667)jyn-3/+3
2023-03-27Don't require $GITHUB_TOKEN to build locally (#1652)jyn-2/+2
2023-02-13Add Neovim configuration information (#1545)Christopher Smyth-1/+1
* Add Neovim configuration information The JSON provided for VSCode works with coc and nlsp-settings. This is verified by https://github.com/fannheyward/coc-rust-analyzer/blob/9d8bdb9290e2a9644367594a1ceed0288506efcd/README.md for coc, and feeding the JSON in to this schema https://github.com/tamago324/nlsp-settings.nvim/blob/215b537cfb3fad7c9c2e352fe47a10698b0993e0/schemas/_generated/rust_analyzer.json for validating nlsp-settings. * Make the steps clear First open a Rust buffer Then update RA settings If you don't open a buffer first then nothing will happen. This is because the plugin makes a raw LSP RPC, so RA must be attached. * Use separate sections for VSCode and Nvim * Add a short section on the VSCode tasks.
2021-07-01Links from rustc-dev-guide to std-dev-guide (#1152)Josh Triplett-0/+3
2021-04-27Replace some Travis-related things completelyYuki Okushi-1/+1
2021-01-20Add mdbook-toc, markers, and documentation (#1028)Iñaki Garay-2/+7
* Add mdbook-toc to travis, book.toml and documentation * Add toc markers * Whitespace cleanup and some punctuation * Addressed comments
2021-01-14Corrected MIR file path and fixed a typo (#1020)saki-osive-1/+1
2020-11-30Improve contributor experience for the dev-guide itself (#973)Joshua Nelson-56/+11
- Fix typos in the README - Don't echo all instructions in the linkcheck.sh shellscript; this is noisy and unhelpful when developing locally. Verbose output is still enabled in CI. - Link to the index page for compiler docs, not `rustc_middle`. Note that the compiler docs are not a guide - that's us! - Remove outdated instructions about avoiding 429s. These should no longer be occurring locally now that we're using caching. - Consolidate info about `mdbook` and `mdbook-linkcheck` near each other
2020-10-11Mention you will need recent versions of mdbook*Camelid-2/+2
2020-10-11Use official mdbook-linkcheck versionCamelid-4/+3
We were using an alpha version before, pinned to a Git hash, so that we could access a new feature (Michael-F-Bryan/mdbook-linkcheck#42). Now there is a point release though (0.7.1), so we can update to that!
2020-10-10Update installation instructions for `mdbook-linkcheck`LeSeulArtichaut-2/+3
2020-10-01Fix incorrect windows linkJoshua Nelson-1/+1
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-10-01Add windows instructionsJoshua Nelson-1/+9
2020-10-01Recommend setting up `check_line_lengths` as a pre-commit scriptJoshua Nelson-0/+11
I've run into lots of annoying failures from this. - Make it runnable without arguments - Add it in the README
2020-08-02Address review commentYuki Okushi-2/+3
2020-08-02Adjust mentions about CI to GitHub ActionsYuki Okushi-1/+4
2020-07-29Update docs to match the new x.py defaults (#813)Joshua Nelson-1/+1
2020-06-02Make travis badge link to travisWho? Me?!-1/+1
2020-04-04[README.md] add build instructions, link check config instructions, link ↵Chris Simpkins-6/+62
check error documentation
2020-03-31Rename `librustc` to `librustc_middle`LeSeulArtichaut-1/+1
2020-03-10Rename rustc-guide to rustc-dev-guide (#601)Santiago Pastorino-10/+10
* Rename rustc-guide to rustc-dev-guide * rust-lang.github.io/rustc-dev-guide -> rustc-dev-guide.rust-lang.org
2020-03-02Spell `Voilà` properly in README.mdLeSeulArtichaut-1/+1
2020-02-02Update READMEWho? Me?!-2/+2
2019-11-05Add travis badge to READMEWho? Me?!-0/+3
2019-10-17I prefers long options in documentationTshepang Lekhonkhobe-1/+2
2019-09-19Add guidance for making a PR fixes toolstateYuki Okushi-1/+11
2019-09-18add some instructions to fix toolstate (#446)Who? Me?!-0/+28
2019-07-17Move into rust-langYuki Okushi-1/+1
2019-01-18Typo + minor editsWho? Me?!-3/+3
2018-12-05fixed typo issues linkAvelino-1/+1
2018-12-01fix some linkrotted linksAndy Wortman-1/+1
2018-10-13Update a few parts of the readmemark-9/+10
2018-09-21update readmeMark Mansi-2/+3
2018-09-21update readme with mdbook versionMark Mansi-1/+1
2018-07-09fix all the not-en-dashesmark-2/+2
2018-07-05add a link to the rustc docsmark-0/+4
2018-04-06Consolidate and fix code blocksvarkor-2/+2