Source location in output for local builds - #571
Merged
Conversation
…ly accurate in "debug" mode, with the pre- and post-processor extension hooks disabled. Source location is lost when these hooks run in normal builds.
Added change log entry.
Contributor
|
@PaulMartinsen -- So is this PR ready for review & merge as part of our next SDPi Friday call on 7 August 2026? |
Collaborator
Author
|
yep. Review, merge and be merry. Hopefully. I'll plan to address any review issues over the weekend. |
ToddCooper
approved these changes
Aug 7, 2026
ToddCooper
left a comment
Contributor
There was a problem hiding this comment.
All changes reviewed and approved
This file contains hidden or 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
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.
📑 Description
This PR adds an extra batch file (
.ci\asciidoc-converter\build_standard_debug.bat) for debugging document build locally with trace that includes reasonably accurate source locations. For example, should one forget the requiredtransaction-idwhen registering a transaction such as:The build trace will report the error with the filename and approximate line number (actually the error is on line 9, not 16):
This may aid in tracking down the offending issue. The document and artefacts will be generated in
sdpi-documents/sdpi-standard-debug/, though it may not be particularly useful because…The downside is that some of the document processing does not occur in debug mode, viz:
IssuesSectionPreprocessor: which populates the document with github issues (though this generally doesn't happen locally anway),DisableSectNumsProcessor: which removes any occurrences of:sectnums:from the document to prevent the AscidoctorJ parser from rendering additional section numbers.ReferenceSanitizerPreprocessor,ReferenceSanitizerPostprocessor: which re-writes links to conform to IHE guidelines.Note
During normal builds, source information is incomprehensible by mortals. The example error above, for example. reports
an error in
sdpi-standard.adoc: line -13633.☑ Mandatory Tasks
The following aspects have been respected by the pull request assignee and at least one reviewer: