add tool to "enforce" semantic line breaks #1485

tshepang · 2022-10-18T05:48:32Z

Run it so:

cd ci/semantic-line-breaks
cargo run --- ../../src [--overwrite]

Diff is large, so maybe should be automated.

No migrations were necessary.

This commit adds initial documentation for LLVM Control Flow Integrity (CFI) support to the Rust compiler (see rust-lang/rust#89652 and rust-lang/rust#89653).

Co-authored-by: Yuki Okushi <jtitor@2k36.org> Co-authored-by: nhamovitz <18648574+nhamovitz@users.noreply.github.com>

This is work toward rust-lang#1241.

Use paragraphs instead of bullet-points. Edits throughout for clarity. Use semantic line breaks in edited sections. Co-authored-by: Joshua Nelson <github@jyn.dev>

This should prevent future failures like this one [1]. [1]: https://github.com/rust-lang/rustc-dev-guide/runs/4067460927?check_suite_focus=true

I removed one of them because it doesn't seem necessary.

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

The italics added in rust-lang#1239 broke the implicitly-resolved link.

* Fix broken links in region_inference.md * Fix broken links in lifetime_parameters.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

…c PR#101558

The proc-macro server path is required for proc-macros to properly work in r-a when working on rustc. Pointing the sysroot to the stage0 one is more correct than using the system installed one.

Previously, "Building and debugging `rustc`" linked to the getting started page, which isn't correct. If people want that page, it already appears in the sidebar, and is the next sequential page.

Co-authored-by: mejrs <>

When doing a git grep (of rustc-dev-guide or of rust-lang/rust with --recurse-submodules), if the grep happens to match within the minified javascript, the resulting long single lines can cause a text pager or editor to slow down and distract from more useful matches. Minified javascript isn't formatted for human consumption, by definition, so mark it as binary, which causes git grep to instead just state that it matches without printing the matching "line".

Using `llvm.godbolt.org` subdomain should automatically select the correct LLVM-IR language.

See rust-lang#1132

JohnTitor · 2022-10-20T10:24:10Z

I don't have an objection to enforcing sembr but the implementation does look fragile, e.g. there's no tokenizer. Have you considered using an existing tool like https://github.com/bobheadxi/readable?

tshepang · 2022-10-20T16:16:08Z

I have not... thanks for the suggestion, will have a look.

m-spitfire · 2023-01-23T16:19:52Z

I have tried using readable to have a GitHub action that runs check, and format all the existing code, but the tool is immature, it gave errors for some files saying Cannot take length of multi-line node '[object Object]' (bobheadxi/readable#18) and for others the aforementioned issue is there, it does the wrong thing when it encounters e.g.(bobheadxi/readable#17). I am not sure what should be done here, make readable better or create another tool?

tshepang · 2023-01-23T20:00:12Z

This tool of mine handles both issues without choking. I intend to get back to making it more fancy... I keep postponing.

Kobzol · 2025-01-05T17:28:06Z

Sorry, due to me messing up a git operation, we sadly had to force-push the whole commit history of rustc-dev-guide :( If you'd like to update this pull request, you will have to rebase it in a special way onto the new commit history (the new master):

git fetch origin --all
git checkout <pr-branch>
git rebase --onto origin/master origin/master-old
git push --force-with-lease

More context can be found here.

lqd and others added 30 commits October 22, 2021 01:00

Describe how to trigger perf runs (rust-lang#1237)

87968b4

Switch date-check to Rust 2021

f68aff5

No migrations were necessary.

Update author field

b060087

Add documentation for LLVM CFI support

68dbb45

This commit adds initial documentation for LLVM Control Flow Integrity (CFI) support to the Rust compiler (see rust-lang/rust#89652 and rust-lang/rust#89653).

Fix rustc_mir related links (rust-lang#1228)

ddaebd8

Co-authored-by: Yuki Okushi <jtitor@2k36.org> Co-authored-by: nhamovitz <18648574+nhamovitz@users.noreply.github.com>

Edit "About this guide" for semantic line feeds

f3fb373

This is work toward rust-lang#1241.

Some minor adjustments to the diagnostic documentation

70966e5

Edit introduction to bootstrapping

0f69d33

Use paragraphs instead of bullet-points. Edits throughout for clarity. Use semantic line breaks in edited sections. Co-authored-by: Joshua Nelson <github@jyn.dev>

enhance subtree docs, link to clippy docs

292072d

Ensure date-check cron job is using latest stable Rust

dac568c

This should prevent future failures like this one [1]. [1]: https://github.com/rust-lang/rustc-dev-guide/runs/4067460927?check_suite_focus=true

Update some date-check comments

f146da3

I removed one of them because it doesn't seem necessary.

Fix date

2ad51b6

Co-authored-by: Yuki Okushi <jtitor@2k36.org>

tiny capitalization fix

a034fad

Remove some legacy test suites.

8a8452c

Add note to emphasize replacing TARGET_TRIPLE (rust-lang#1250)

ffcc629

Fix typo: [upv.rs_mentioned] -> [upvars_mentioned]

196ef69

Fix broken link in "Bootstrapping"

6b9c8ae

The italics added in rust-lang#1239 broke the implicitly-resolved link.

Fix compare-mode documentation

f1297f5

Spelling fixes

0fc1fa9

Unify x.py usage (rust-lang#1258)

24132fa

Fix broken links related to rustc_borrowck (rust-lang#1259)

766f9d7

* Fix broken links in region_inference.md * Fix broken links in lifetime_parameters.md

Fix an invalid link on Diagnostic Items (rust-lang#1261)

5fbfe93

Describe drop elaboration (rust-lang#1240)

a2fc963

make it compile with 1.56.0

6a27fc2

make it compile with 1.56.0

1f0c4f0

make it compile with 1.56.0 no warning

94e9e67

Document more compiletest headers.

285b3e4

Apply suggestions from pierwill

9660c15

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

Document rustfix-only-machine-applicable

aaf6ccc

Update for review comments.

8a817bc

JhonnyBillM and others added 16 commits September 22, 2022 10:29

UPDATE - Diagnostic docs to reflect renamed traits and macros in rust…

1c79085

…c PR#101558

don't refer to the compile-time interpreter as "Miri" (rust-lang#1471)

7743f0f

Update r-a config suggestions

ed11720

The proc-macro server path is required for proc-macros to properly work in r-a when working on rustc. Pointing the sysroot to the stage0 one is more correct than using the system installed one.

Link to the correct page in "about this guide"

1370793

Previously, "Building and debugging `rustc`" linked to the getting started page, which isn't correct. If people want that page, it already appears in the sidebar, and is the next sequential page.

Update about-this-guide.md

de71812

fix typo and make paragraph consistent (rust-lang#1474)

882921a

Rename typeck to hir_analysis (rust-lang#1475)

b8228e9

Co-authored-by: mejrs <>

Update running tests with the new flags (rust-lang#1476)

d3ce60f

diagnostic structs: derive on enum (rust-lang#1477)

57a38ad

fix very minor punctuation typo

0932ad6

Use llvm subdomain for compiler-explorer link

509ee50

Using `llvm.godbolt.org` subdomain should automatically select the correct LLVM-IR language.

Update debugging.md

7518c34

Add missing prerequisite for some Linux distros (rust-lang#1481)

e68dfb8

add tool to "enforce" semantic line breaks

77bfaff

See rust-lang#1132

do not overwrite unconditionally

19d2632

tshepang force-pushed the semantic-line-breaks branch from d1feea4 to 19d2632 Compare October 18, 2022 06:16

JohnTitor added the S-waiting-on-author Status: this PR is waiting for additional action by the OP label Oct 22, 2022

bobheadxi mentioned this pull request Feb 27, 2023

Formats in the middle of sentence when faces e.g. bobheadxi/readable#17

Closed

tshepang marked this pull request as draft March 6, 2023 06:58

Noratrieb mentioned this pull request Mar 30, 2024

Delete length check #1952

Merged

jieyouxu added C-CI Category: CI for this repo A-style Area: style WG-rustc-dev-guide Working group: rustc-dev-guide labels Nov 4, 2024

Kobzol force-pushed the master branch from 340f758 to 885fd79 Compare January 5, 2025 17:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add tool to "enforce" semantic line breaks #1485

add tool to "enforce" semantic line breaks #1485

tshepang commented Oct 18, 2022 •

edited

Loading

JohnTitor commented Oct 20, 2022

tshepang commented Oct 20, 2022

m-spitfire commented Jan 23, 2023 •

edited

Loading

tshepang commented Jan 23, 2023

Kobzol commented Jan 5, 2025

add tool to "enforce" semantic line breaks #1485

Are you sure you want to change the base?

add tool to "enforce" semantic line breaks #1485

Conversation

tshepang commented Oct 18, 2022 • edited Loading

JohnTitor commented Oct 20, 2022

tshepang commented Oct 20, 2022

m-spitfire commented Jan 23, 2023 • edited Loading

tshepang commented Jan 23, 2023

Kobzol commented Jan 5, 2025

tshepang commented Oct 18, 2022 •

edited

Loading

m-spitfire commented Jan 23, 2023 •

edited

Loading