• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Community
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
  • Software-verification
    • Kestrel-books
      • Crypto-hdwallet
      • Apt
        • Isodata
        • Simplify-defun
        • Tailrec
        • Schemalg
        • Restrict
        • Expdata
        • Casesplit
        • Simplify-term
        • Simplify-defun-sk
        • Parteval
        • Solve
        • Wrap-output
        • Propagate-iso
        • Simplify
        • Finite-difference
        • Drop-irrelevant-params
        • Copy-function
        • Lift-iso
        • Rename-params
        • Utilities
          • Defaults-table
          • Xdoc::apt-constructors
            • Xdoc::desc-apt-input-thm-name
            • Xdoc::desc-apt-input-thm-enable
            • Xdoc::desc-apt-input-verify-guards
            • Xdoc::apt-design-notes-ref
            • Xdoc::desc-apt-input-wrapper-to-old-name
            • Xdoc::desc-apt-input-old-to-wrapper-name
            • Xdoc::desc-apt-input-wrapper-to-old-enable
            • Xdoc::desc-apt-input-wrapper-name
            • Xdoc::desc-apt-input-old-to-wrapper-enable
            • Xdoc::desc-apt-input-old-to-new-name
            • Xdoc::desc-apt-input-old-if-new-name
            • Xdoc::desc-apt-input-new-to-old-name
            • Xdoc::desc-apt-input-wrapper-enable
            • Xdoc::desc-apt-input-old-to-new-enable
            • Xdoc::desc-apt-input-old-if-new-enable
            • Xdoc::desc-apt-input-new-to-old-enable
            • Xdoc::desc-apt-input-new-name
            • Xdoc::desc-apt-input-untranslate
            • Xdoc::desc-apt-input-old
            • Xdoc::desc-apt-input-new-enable
            • Xdoc::desc-apt-input-wrapper
          • Input-processors
          • Transformation-table
          • Find-base-cases
          • Untranslate-specifier-utilities
          • Print-specifier-utilities
          • Hints-specifier-utilities
        • Simplify-term-programmatic
        • Simplify-defun-sk-programmatic
        • Simplify-defun-programmatic
        • Simplify-defun+
        • Common-options
        • Common-concepts
      • Error-checking
      • Fty-extensions
      • Isar
      • Kestrel-utilities
      • Set
      • C
      • Soft
      • Bv
      • Imp-language
      • Ethereum
      • Event-macros
      • Java
      • Riscv
      • Bitcoin
      • Zcash
      • Yul
      • ACL2-programming-language
      • Prime-fields
      • Json
      • Syntheto
      • File-io-light
      • Cryptography
      • Number-theory
      • Axe
      • Lists-light
      • Builtins
      • Solidity
      • Helpers
      • Htclient
      • Typed-lists-light
      • Arithmetic-light
    • X86isa
    • Axe
    • Execloader
  • Math
  • Testing-utilities

• Xdoc::apt-constructors

Xdoc::desc-apt-input-verify-guards

Build a description of the :verify-guards input for the user documentation of an APT transformation.

The :plural parameter of this macro indicates whether the transformation generates multiple functions or not. Based on that, the text is slightly customized with plural for `generated functions' or not.

The :additional-text parameter of this macro must be either nil (the default) or an XDOC tree. The tree (if any) is added at the end of the boilerplate text.

Macro: desc-apt-input-verify-guards

(defmacro xdoc::desc-apt-input-verify-guards
          (&key (plural-functions 't)
                additional-text)
 (declare (xargs :guard (booleanp plural-functions)))
 (cons
  'xdoc::desc
  (cons
   '"@(':verify-guards') — default @(':auto')"
   (cons
    (cons 'xdoc::p
          (cons '"Determines whether the guards of the generated "
                (cons (if plural-functions "functions"
                        "functions")
                      '(" are verified or not."))))
    (cons
     '(xdoc::p "It must be one of the following:")
     (cons
      '(xdoc::ul
        (xdoc::li "@('t'), to verify the guards.")
        (xdoc::li "@('nil'), to not verify guards.")
        (xdoc::li
         "@(':auto'), to verify the guards if and only if
       the guards of the target function @('old') are verified."))
      (and additional-text
           (list additional-text))))))))