[top-posting, to everyone's comments so far] I find that the ASCII-armor CODE BEGINS/CODE ENDS is an undesirable relic from days before XML-based RFCs. Now that RFCs are XML-native, better constructs are possible. I do not think that extracting from Text-formatted RFCs is necessary. Being able to extract from just XML is fine. Therefore I do NOT support adding support for code-tags for examples.
Please note this (somewhat abandoned) project: https://pypi.org/project/xiax. The source code is on GitHub here: https://github.com/kwatsen/xiax. The idea was 1) to replace a whole bunch of shell-scripts I use to build XML-documents to upload to Datatracker and 2) make it possible for any downstream consumer (shepherd, AD, IESG, RFC Editor, etc) to run a command that would quickly validate all the YANG and examples contained in the document. I abandoned the effort because (as I think Andy wrote) sometime the validation context is much more than what is contained in the document, e.g., many of the client-server drafts assume a context defined in the truststore and keystore RFCs. Ultimately, after significant effort, I figured it was not a problem I wanted to invest more time trying to solve. That said, it does seem to be the focus of the Onions WG, so maybe it can be resurrected or used for inspiration? Pro-tip: xiax stores a whole bunch of metadata/files into a secret XML-comment block (##xiax-block-v1:), which I discovered is not stripped by Datatracker during the submission process. As Lada mentioned here <https://mailarchive.ietf.org/arch/msg/netmod/U8FY-Z9lvS3gR89xjXCRNm6dqDE/>, Yangson has already the ability to accumulate/report coverage statistics. The goal, or course, is that no node in the tree reports zero (0) hits after all validation-tests have run. If all nodes have hits, then 100% coverage has been achieved. Ideally, RFCs would have 100% test coverage: not only showing that the YANG is good, but also that the examples in the document are good. Unfortunately, this entails documents needing complete examples, not example-snippets... Kent // contributor
_______________________________________________ netmod mailing list -- [email protected] To unsubscribe send an email to [email protected]
