Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Various MPS documents contain syntax and reference errors #113

Closed
rptb1 opened this issue Jan 14, 2023 · 4 comments · Fixed by #112 or #152
Closed

Various MPS documents contain syntax and reference errors #113

rptb1 opened this issue Jan 14, 2023 · 4 comments · Fixed by #112 or #152
Assignees
@rptb1
Labels
documentation optional Will cause failures / of benefit. Worth assigning resources.

Comments

@rptb1
Copy link
Member

rptb1 commented Jan 14, 2023

Various minor errors have crept into MPS documents, such as design documents.

I noticed some by inspection then wrote a command line to run documents through rst2html and found these:

./procedure/release-build.rst:283: (WARNING/2) malformed hyperlink target.
./procedure/release-build.rst:276: (ERROR/3) Unknown target name: "pnj".
./design/protix.txt:4: (WARNING/2) Duplicate explicit target name: ".fun.set.assume.mprotect".
./design/config.txt:4: (WARNING/2) Duplicate explicit target name: ".var".
./design/arena.txt:4: (WARNING/2) Duplicate explicit target name: ".tract.field.base".
./design/poolawl.txt:247: (ERROR/3) Unknown target name: ".poolstruct.gen".
./design/poolamc.txt:4: (WARNING/2) Duplicate explicit target name: ".intro".
./design/poolamc.txt:4: (WARNING/2) Duplicate explicit target name: ".readership".
./design/shield.txt:259: (ERROR/3) Unknown target name: ".inv.unsynced.suspend".
./design/prmc.txt:4: (WARNING/2) Duplicate explicit target name: ".if.init.thread".
./design/protocol.txt:572: (ERROR/3) Unknown target name: ".if.subclass".

Not hard to fix up. Care must be taken not to change tags without searching for references. Grep is your friend.

We can use some automation to prevent them happening again.
@rptb1 rptb1 self-assigned this Jan 14, 2023
@rptb1 rptb1 linked a pull request Jan 14, 2023 that will close this issue
Check the syntax of reStructuredText files during CI #112
Merged
@rptb1 rptb1 mentioned this issue Jan 14, 2023
Merged
@rptb1 rptb1 added optional Will cause failures / of benefit. Worth assigning resources. documentation labels Jan 15, 2023
@UNAA008
Copy link
Contributor

UNAA008 commented Feb 10, 2023

Submission of #112 caused errors in reStructedText files.
https://github.com/Ravenbrook/mps/actions/runs/4146422245/jobs/7172058645

@UNAA008 UNAA008 reopened this Feb 10, 2023
@rptb1
Copy link
Member Author

rptb1 commented Feb 10, 2023 •
edited
Loading

That indicates a flaw in the proc.merge.pull-request checklist item 9, because the trial merge wasn't reliable, being quite old. A catch-up merge from master would've kicked the CI and found this before the commit to master. Or we could kick the CI with tools.

@rptb1
Copy link
Member Author

rptb1 commented Feb 23, 2023

Submission of #112 caused errors in reStructedText files. https://github.com/Ravenbrook/mps/actions/runs/4146422245/jobs/7172058645

Fixed by #141 in eed418b

@rptb1
Copy link
Member Author

rptb1 commented Feb 23, 2023

That indicates a flaw in the proc.merge.pull-request checklist item 9, because the trial merge wasn't reliable, being quite old. A catch-up merge from master would've kicked the CI and found this before the commit to master. Or we could kick the CI with tools.

Fixed by #152 in 990612d

@rptb1 rptb1 linked a pull request Feb 23, 2023 that will close this issue
Process improvements for 2023-02-10/17 #152
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rptb1 rptb1

Labels
documentation optional Will cause failures / of benefit. Worth assigning resources.
Projects
None yet
Milestone
No milestone
2 participants
@rptb1 @UNAA008