Skip to content

Commit 14b243d

Browse files
Julian-Wollersbergermark-i-m
authored andcommitted
Renamed the file and title of the diagnostics chapter.
When I recently searched for infos in this guide on how to create a warning, I couldn't find any. Later I found it through #14. The reason was that I didn't know the term 'diagnostics' and that it is the collective term for errors, warnings and lints. Renaming the chapter to include the word 'error' should help. I think also including 'warning' in the title shouldn't be neccessary, because it's close enought.
1 parent 673b4a4 commit 14b243d

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

src/SUMMARY.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121
- [with the linux perf tool](./profiling/with_perf.md)
2222
- [Coding conventions](./conventions.md)
2323
- [crates.io Dependencies](./crates-io.md)
24+
- [Emitting Errors and other Diagnostics](diagnostics.md)
25+
- [JSON diagnostic format](diagnostics/json-format.md)
2426

2527
---
2628

@@ -83,8 +85,6 @@
8385
- [Code Generation](./codegen.md)
8486
- [Updating LLVM](./codegen/updating-llvm.md)
8587
- [Debugging LLVM](./codegen/debugging.md)
86-
- [Emitting Diagnostics](./diag.md)
87-
- [JSON diagnostic format](./diag/json-format.md)
8888
- [Profile-guided Optimization](./profile-guided-optimization.md)
8989

9090
---

src/appendix/code-index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Item | Kind | Short description | Chapter |
3838
[Type checking]: ../type-checking.html
3939
[The `ty` modules]: ../ty.html
4040
[Rustdoc]: ../rustdoc.html
41-
[Emitting Diagnostics]: ../diag.html
41+
[Emitting Diagnostics]: ../diagnostics.html
4242
[Macro expansion]: ../macro-expansion.html
4343
[Name resolution]: ../name-resolution.html
4444
[Parameter Environment]: ../param_env.html

src/diag.md src/diagnostics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Emitting Diagnostics
1+
# Emitting Errors and other Diagnostics
22

33
A lot of effort has been put into making `rustc` have great error messages.
44
This chapter is about how to emit compile errors and lints from the compiler.
File renamed without changes.

src/implementing_new_features.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ In some cases, a feature or bugfix might break some existing programs
4949
in some edge cases. In that case, you might want to do a crater run
5050
to assess the impact and possibly add a future-compatibility lint,
5151
similar to those used for
52-
[edition-gated lints](./diag.md#edition-gated-lints).
52+
[edition-gated lints](diagnostics.md#edition-gated-lints).
5353

5454
### Stability
5555

0 commit comments

Comments
 (0)