Commit Graph

54 Commits

Author SHA1 Message Date
Tshepang Mbambo 8e8bc1d999
add rdg push git config entry for git protocol pushers 2025-05-01 07:38:29 +02:00
Tshepang Mbambo ac84606523 toolchain version does not need to be specified
- 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-19 13:34:13 +02:00
Tshepang Mbambo 1bc859ed76
readme: be copy-paste friendly 2025-04-19 13:08:43 +02:00
许杰友 Jieyou Xu (Joe) 589573c793 Document `fetch.prunetags = true` gotcha during rustc-pull 2025-03-13 15:44:23 +08:00
许杰友 Jieyou Xu (Joe) 81e9f12d3b docs: document how to install a suitable `josh-proxy` locally
Co-authored-by: Boxy <rust@boxyuwu.dev>
2025-01-20 12:35:45 +08:00
Jakub Beránek 4a73ebae45 Add tooling for performing Josh synces (#2183) 2025-01-05 17:51:45 +01:00
Noah Lev d85deb6064 Opt into, rather than out of, linkcheck (#2180)
This makes it less of a hassle to render the book locally.
2024-12-30 17:22:22 +08:00
Martin Liška c609846601 Remove properly tracked config file from .gitignore & add support for 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-29 13:23:49 -08:00
Martin Liška 0d9aca4ccd Start using mdbook-linkcheck2 (#2103) 2024-12-28 15:00:32 -08:00
Nilstrieb 023c0f2592 Delete length check (#1952)
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.
2024-03-30 17:46:30 +01:00
sslime336 a04ad82e3c Change `./x.py` into `./x` 2023-06-30 23:11:14 +02:00
jyn c6cd62cf77 Various improvements to `check_line_lengths.sh` (#1667) 2023-04-09 12:08:46 +09:00
jyn b4b007be06 Don't require $GITHUB_TOKEN to build locally (#1652) 2023-03-27 00:28:07 +09:00
Christopher Smyth b4689c9511 Add Neovim configuration information (#1545)
* Add Neovim configuration information
The JSON provided for VSCode works with coc and nlsp-settings.
This is verified by
9d8bdb9290/README.md
for coc, and feeding the JSON in to this schema
215b537cfb/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.
2023-02-13 23:16:01 -06:00
Josh Triplett 76c1d45ae5 Links from rustc-dev-guide to std-dev-guide (#1152) 2021-07-01 13:19:06 +02:00
Yuki Okushi ee94932928 Replace some Travis-related things completely 2021-04-27 13:15:39 -04:00
Iñaki Garay 7a80b01e01 Add mdbook-toc, markers, and documentation (#1028)
* Add mdbook-toc to travis, book.toml  and documentation

* Add toc markers

* Whitespace cleanup and some punctuation

* Addressed comments
2021-01-20 14:33:11 -03:00
saki-osive eeb696d8a4 Corrected MIR file path and fixed a typo (#1020) 2021-01-14 14:10:08 -08:00
Joshua Nelson a64e819af8 Improve contributor experience for the dev-guide itself (#973)
- 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-11-30 11:08:32 -03:00
Camelid da36052173 Mention you will need recent versions of mdbook* 2020-10-11 17:51:07 -04:00
Camelid d89ecf02aa Use official mdbook-linkcheck version
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-11 17:51:07 -04:00
LeSeulArtichaut f3de6c7166 Update installation instructions for `mdbook-linkcheck` 2020-10-10 12:39:19 -04:00
Joshua Nelson 219c8df6dc Fix incorrect windows link
Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
2020-10-01 01:27:11 -04:00
Joshua Nelson a4a89a549d Add windows instructions 2020-10-01 01:27:11 -04:00
Joshua Nelson 3f1414cb00 Recommend setting up `check_line_lengths` as a pre-commit script
I've run into lots of annoying failures from this.

- Make it runnable without arguments
- Add it in the README
2020-10-01 01:27:11 -04:00
Yuki Okushi c793ecbcf8 Address review comment 2020-08-02 08:38:26 -05:00
Yuki Okushi 9c351189e9 Adjust mentions about CI to GitHub Actions 2020-08-02 08:38:26 -05:00
Joshua Nelson 879ca582de Update docs to match the new x.py defaults (#813) 2020-07-29 04:20:00 +09:00
Who? Me?! 32d7535b16 Make travis badge link to travis 2020-06-02 19:46:12 -05:00
Chris Simpkins 517d910523 [README.md] add build instructions, link check config instructions, link check error documentation 2020-04-04 12:07:30 -05:00
LeSeulArtichaut cb99cfcc1e Rename `librustc` to `librustc_middle` 2020-03-31 15:43:14 -05:00
Santiago Pastorino c05ed676d2 Rename rustc-guide to rustc-dev-guide (#601)
* Rename rustc-guide to rustc-dev-guide

* rust-lang.github.io/rustc-dev-guide -> rustc-dev-guide.rust-lang.org
2020-03-10 11:01:43 -03:00
LeSeulArtichaut d97b5f1750 Spell `Voilà` properly in README.md 2020-03-02 16:26:27 -06:00
Who? Me?! a46f4c1f46 Update README 2020-02-02 23:53:39 -06:00
Who? Me?! ebd0104b77 Add travis badge to README 2019-11-05 11:59:04 -06:00
Tshepang Lekhonkhobe 1d8db1a89d I prefers long options in documentation 2019-10-17 23:14:34 -05:00
Yuki Okushi d290423947 Add guidance for making a PR fixes toolstate 2019-09-19 20:21:14 -05:00
Who? Me?! 2862a289ec add some instructions to fix toolstate (#446) 2019-09-18 09:50:39 -03:00
Yuki Okushi da54032682 Move into rust-lang 2019-07-17 10:40:33 -05:00
Who? Me?! b181fb01ee Typo + minor edits 2019-01-18 14:36:52 -06:00
Avelino ca8476d871 fixed typo issues link 2018-12-05 16:54:58 -06:00
Andy Wortman e3c1238b29 fix some linkrotted links 2018-12-01 21:57:43 -06:00
mark 86301aa315 Update a few parts of the readme 2018-10-13 11:35:53 -05:00
Mark Mansi b50d681d85 update readme 2018-09-21 15:54:25 -05:00
Mark Mansi 6278ad42c6 update readme with mdbook version 2018-09-21 15:54:25 -05:00
mark 8a49eb7686 fix all the not-en-dashes 2018-07-09 21:45:49 -05:00
mark 769b33c7e3 add a link to the rustc docs 2018-07-05 09:21:45 -05:00
varkor ad35712ddc Consolidate and fix code blocks 2018-04-06 14:18:08 -05:00
Who? Me?! 14857e062f Update README.md 2018-02-04 16:11:19 -06:00
Michael Bryan b6105db8dc Added a note about how to use mdbook-linkcheck 2018-01-31 14:13:10 -05:00