• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
    • Hardware-verification
      • Gl
      • Esim
      • Vl2014
      • Sv
        • Svex-stvs
          • Svtv-data
          • Defsvtv$
          • Svtv-run
          • Defsvtv-phasewise
          • Svtv
          • Svtv-spec
          • Defsvtv
          • Process.lisp
          • Svtv-doc
            • Svtv-to-xml
            • Stv-entry-to-xml
            • Stv-line-to-xml
            • Stv-entries-to-xml
            • Stv-lines-to-xml
            • 4vec-to-bitwise-chars
            • Stv-repeat-last-entry
            • Stv-repeat-last-entries
            • 4vec-to-hex-chars
            • 4vec-to-hex-char
            • Stv-name-to-xml
            • Stv-labels-to-xml
            • 4vec-to-xml-chars
          • Svtv-chase$
          • Svtv-versus-stv
          • Svtv-debug-fsm
          • Structure.lisp
          • Svtv-debug
          • Def-pipeline-thm
          • Expand.lisp
          • Def-cycle-thm
          • Svtv-utilities
          • Svtv-debug$
          • Defsvtv$-phasewise
        • Svex-decomposition-methodology
        • Sv-versus-esim
        • Svex-decomp
        • Svex-compose-dfs
        • Svex-compilation
        • Moddb
        • Svmods
        • Svstmt
        • Sv-tutorial
        • Expressions
        • Symbolic-test-vector
        • Vl-to-svex
      • Fgl
      • Vwsim
      • Vl
      • X86isa
      • Svl
      • Rtl
    • Software-verification
    • Math
    • Testing-utilities
  • Svex-stvs

Svtv-doc

Automatic documentation support for svex symbolic test vectors.

Symbolic test vectors are integrated into ACL2::xdoc so that you can generate attractive explanations of your setup. This is often useful when communicating with logic designers.

NOTE: the topics here cover how we generate this documentation. If you just want to document your own SVTVs, you don't need to know about any of this—just give a :parents, :short, or :long argument to defstv.

These functions don't do much error checking. We expect that we only are going to generate documentation after successfully processing the SVTV, so we generally just expect things to be well-formed at this point.

The XML we generate is not documented in ACL2::xdoc's xdoc::markup, and is not supported by tools like :xdoc. How these new tags get rendered into HTML is controlled by, e.g., xdoc/fancy/render.xsl.

Subtopics

Svtv-to-xml
Top-level routine to generate a nice XML description of an STV.
Stv-entry-to-xml
Encode a single value from an STV line.
Stv-line-to-xml
Encode one full line from the STV into XML for XDOC.
Stv-entries-to-xml
Encode all the values from an STV line.
Stv-lines-to-xml
4vec-to-bitwise-chars
Stv-repeat-last-entry
Stv-repeat-last-entries
4vec-to-hex-chars
4vec-to-hex-char
Stv-name-to-xml
Encode the name of an STV line.
Stv-labels-to-xml
4vec-to-xml-chars