Feature: :srcref: can deep-link to specific source lines
#188
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
:srcref: can now also specify a specific source line, along with a string that is expected to be found in this line. This search string can be checked-for in CI to catch when line annotations and upstream source code diverge.
This was referenced Feb 16, 2024
Merged
FAlbertDev
approved these changes
Feb 19, 2024
reneme
added a commit
that referenced
this pull request
Feb 19, 2024
... most notably, add deep-links to keygen, encaps and decaps in the upstream implementation. This uses functionality recently merged in GH #188.
reneme
added a commit
that referenced
this pull request
Feb 19, 2024
... most notably, add deep-links to keygen, encaps and decaps in the upstream implementation. This uses functionality recently merged in GH #188.
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.
This extends the
:srcref:rST role with deep-links into specific source lines. This feature was explicitly requested here. Additionally, I integrated the:srcref:extension @FAlbertDev added in #186.As an example, I deep-linked a source location in the Kyber crypto doc. The result (in HTML output) looks like that:
... and links to: https://github.com/randombit/botan/blob/7f15ce7b39d6bd34dda9af4d2cb08a6e18c64c01/src/lib/pubkey/kyber/kyber_common/kyber.cpp#L1042
Usage
In reStructuredText the
:srcref:annotation understands the following::srcref:`src/lib/hash/sha1/sha1.cpp`sha1.cppon GitHub, using the full path as link text, namely "src/lib/hash/sha1/sha1.cpp".:srcref:`src/lib/pubkey/xmss/`xmssdirectory on GitHub, using the full path as link text, namely "src/lib/pubkey/xmss".:srcref:`XMSS <src/lib/pubkey/xmss/>`xmssdirectory, using "XMSS" as link text.:srcref:`\[src/lib/hash]/sha1/sha1.cpp`sha1.cpp, using an elided path as link text, namely: ".../sha1/sha1.cpp".:srcref:`TLS 1.3 key export <src/lib/tls/tls13/tls_cipher_state.cpp:400|CipherState::export_key>`tls_cipher_state.cppline 400, using "TLS 1.3 key export" as link text. The stringCipherState::export_keymust be found in this line, so that a Continuous Integration job can check that the deep-link didn't get out of sync with the upstream source code.:srcref:`\[src/lib/tls/tls13]/tls_cipher_state.cpp:400|CipherState::export_key>`tls_cipher_state.cppline 400, using an elided path as link text, namely: "...tls_cipher_state.cpp:400". The search string works the same as explained above.