rustc-dev-guide: Der Arbeitsplan hinter dem Rust-Compiler

Orientierung statt fertiger Compilerdokumentation

Die README beschreibt den Guide als gemeinschaftliches Projekt. Sein Zweck ist Orientierung: Neue Beitragende sollen rustc kennenlernen, erfahrene Personen sollen in einen neuen Teil des Compilers finden. Das ist ein redaktionelles und technisches Hilfsmittel, kein Compilerpaket und kein Laufzeitdienst. Für die Standardbibliothek verweist der Text ausdrücklich auf den getrennten std-dev-guide. Daraus folgt eine klare Grenze: Aussagen über rustc dürfen nicht automatisch als vollständige Dokumentation der Standardbibliothek gelesen werden. Der rustc-dev-guide ist ein gemeinschaftlich gepflegter Leitfaden zu Arbeitsweise und Beiträgen rund um rustc. Er richtet sich an neue Mitwirkende und an erfahrene Personen, die einen bislang unbekannten Compilerbereich erschließen.

Der mdBook-Aufbau ist Teil des Arbeitsmodells

Die Seiten liegen unter `src/`, die Navigation steht in `src/SUMMARY.md`, die Konfiguration in `book.toml`, Bilder liegen unter `src/img`, und erzeugte HTML-Dateien werden unter `book/html` abgelegt. Eine neue Seite ohne Eintrag in `SUMMARY.md` wird laut README nicht angezeigt. Diese Struktur ist für Beiträge wichtiger als eine bloße Markdown-Datei, weil Inhalt und Navigation gemeinsam gepflegt werden müssen. Der rustc-dev-guide ist ein gemeinschaftlich gepflegter Leitfaden zu Arbeitsweise und Beiträgen rund um rustc. Er richtet sich an neue Mitwirkende und an erfahrene Personen, die einen bislang unbekannten Compilerbereich erschließen.

Lokaler Build mit mdBook

Die README nennt die Installation mit `cargo install --locked mdbook mdbook-linkcheck2 mdbook-mermaid`. Danach startet `mdbook serve --open` einen lokalen Server; für einen einmaligen Build dient `mdbook build`. Der Befehl `--locked` bindet die im Projekt festgelegten Abhängigkeiten ein. Das README nennt keinen festen Port und keine Aussage zur öffentlichen Bereitstellung. Ein erster Test sollte deshalb prüfen, ob der lokale Build endet und ob eine neue Seite über `SUMMARY.md` erreichbar ist. Der rustc-dev-guide ist ein gemeinschaftlich gepflegter Leitfaden zu Arbeitsweise und Beiträgen rund um rustc. Er richtet sich an neue Mitwirkende und an erfahrene Personen, die einen bislang unbekannten Compilerbereich erschließen.

Linkprüfung und CI sind getrennte Schritte

Links werden mit `mdbook-linkcheck2 --standalone` geprüft. Lokal läuft diese Prüfung nicht standardmäßig; mit `ENABLE_LINKCHECK=1 mdbook serve` kann sie aktiviert werden. In CI werden die Links laut README geprüft. Weitere Werkzeuge liegen unter `ci/`: semantische Zeilenumbrüche werden über `cargo run --manifest-path ci/sembr/Cargo.toml src` kontrolliert, Datumsmarkierungen über `cargo run --manifest-path ci/date-check/Cargo.toml .`. Diese Befehle zeigen konkrete Pflegeaufgaben, ersetzen aber keine inhaltliche Prüfung. Der rustc-dev-guide ist ein gemeinschaftlich gepflegter Leitfaden zu Arbeitsweise und Beiträgen rund um rustc. Er richtet sich an neue Mitwirkende und an erfahrene Personen, die einen bislang unbekannten Compilerbereich erschließen.

Wie neue Beiträge beginnen

Wer eine Lücke findet, soll ein Issue eröffnen; vorhandene Issues sollen vor der Arbeit kommentiert werden, damit parallele Arbeit nicht doppelt entsteht. Die README sagt auch, dass der Guide eine niedrigere Hürde für gemergte Pull Requests hat und auf die Forge-Regeln verweist. Wer den Compilerbereich noch nicht kennt, kann laut Projekt mit einer fachkundigen Person sprechen und das Gelernte anschließend dokumentieren. Der Ablauf setzt also Austausch und redaktionelle Nacharbeit voraus, nicht nur lokales Schreiben. Der rustc-dev-guide ist ein gemeinschaftlich gepflegter Leitfaden zu Arbeitsweise und Beiträgen rund um rustc. Er richtet sich an neue Mitwirkende und an erfahrene Personen, die einen bislang unbekannten Compilerbereich erschließen.

Synchronisierung mit rust-lang/rust

Der Guide ist über einen josh-Subtree mit rust-lang/rust verbunden. Für die Synchronisierung wird auf rustc-josh-sync und auf `src/external-repos.md` verwiesen. Die README liefert keinen vollständigen Konflikt- oder Freigabeablauf. Wer an synchronisierten Inhalten arbeitet, muss deshalb den konkreten Abschnitt konsultieren und darf eine lokale Änderung nicht ungeprüft als Änderung am Hauptrepository betrachten. Der rustc-dev-guide ist ein gemeinschaftlich gepflegter Leitfaden zu Arbeitsweise und Beiträgen rund um rustc. Er richtet sich an neue Mitwirkende und an erfahrene Personen, die einen bislang unbekannten Compilerbereich erschließen.

Geeigneter Einsatz und Prüfgrenze

Der Guide ist passend, wenn jemand rustc-Architektur verstehen oder Dokumentation für Compilerbeiträge verbessern muss. Er ist nicht als Ersatz für API-Dokumentation, Buildsystemwissen oder eine Garantie für stabile interne Schnittstellen beschrieben. Prüfe in einer Arbeitskopie zuerst `cargo install --locked mdbook mdbook-linkcheck2 mdbook-mermaid`, danach `mdbook build`; füge eine Testseite in `src/` ein und verlinke sie in `src/SUMMARY.md`. Erst wenn HTML und die projektspezifischen CI-Befehle funktionieren, ist der redaktionelle Beitrag ausreichend geprüft. Der rustc-dev-guide ist ein gemeinschaftlich gepflegter Leitfaden zu Arbeitsweise und Beiträgen rund um rustc. Er richtet sich an neue Mitwirkende und an erfahrene Personen, die einen bislang unbekannten Compilerbereich erschließen.

Redaktionelles Fazit

Geeignet ist rust-lang/rustc-dev-guide für den dokumentierten Zweck, wenn die eigene Umgebung zu den genannten Voraussetzungen passt. Ungeeignet ist eine pauschale Übernahme ohne Versionsprüfung. Prüfe zuerst das konkrete README mit einem projektspezifischen Befehl, einer benannten Datei und dem beobachtbaren Ergebnis; erst danach sollte der Einsatzumfang festgelegt werden.

Offizielle Quellen

1. Official documentation
2. Official README
3. Project repository