Add Misc.print_see_manual for easier printing of "see manual section X.Y.Z" #12125
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Octachron
approved these changes
Mar 22, 2023
There was a problem hiding this comment.
This is a good extension of the manual cross-reference checkers that makes it possible to simplify the code in the compiler and uniformize the format of the references to the manual in warnings and error messages.
This is a clear improvement in the distribution of complexity in the code base.
gasche
reviewed
Mar 22, 2023
Changes
Outdated
| @@ -552,6 +552,10 @@ Working version | |||
| cu_required_globals field of compilation unit descriptors. | |||
| (Sébastien Hinderer, review by Vincent Laviron) | |||
|
|
|||
| - #????: Add Misc.print_see_manual and modify [@manual_ref] to accept | |||
| lists for simpler printing of manual references | |||
| (Stefan Muenzel, review by ????) | |||
There was a problem hiding this comment.
This needs to be filled in before merging. (I almost merged.)
There was a problem hiding this comment.
Done! I left it purposefully vague in case someone other than @Octachron wanted to jump in to review
There was a problem hiding this comment.
Nah, I'm too busy making noob mistakes in C code.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisite to #12051
Make printing references to manual sections easier/more consistent by adding
Misc.print_see_manual.Additionally, modify the manual check to accept lists of manual sections, so that we can easily pass these as a parameter to
print_see_manual.This PR also makes some manual references more detailed.