• Top
    • Documentation
    • Books
    • Recursion-and-induction
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
    • Hardware-verification
    • Software-verification
      • Kestrel-books
        • Crypto-hdwallet
        • Error-checking
        • Apt
        • Abnf
        • Fty-extensions
        • Isar
        • Kestrel-utilities
          • Omaps
          • Directed-untranslate
          • Include-book-paths
          • Ubi
          • Checkpoint-list
          • Digits-any-base
          • Context-message-pair
          • Numbered-names
          • With-auto-termination
          • Theorems-about-true-list-lists
          • Make-termination-theorem
          • Sublis-expr+
          • Prove$
          • Defthm<w
          • System-utilities-non-built-in
          • Integer-range-fix
          • Add-const-to-untranslate-preprocess
          • Integers-from-to
          • Minimize-ruler-extenders
          • Unsigned-byte-fix
          • Signed-byte-fix
          • Defthmr
          • Paired-names
          • Unsigned-byte-list-fix
          • Signed-byte-list-fix
          • Show-books
          • Checkpoint-list-pretty
          • List-utilities
          • Skip-in-book
            • Typed-tuplep
            • Defunt
            • Keyword-value-list-to-alist
            • Magic-macroexpand
            • Top-command-number-fn
            • Bits-as-digits-in-base-2
            • Show-checkpoint-list
            • Ubyte11s-as-digits-in-base-2048
            • Named-formulas
            • Bytes-as-digits-in-base-256
            • String-utilities
            • Make-keyword-value-list-from-keys-and-value
            • Integer-range-listp
            • Defmacroq
            • Apply-fn-if-known
            • Trans-eval-error-triple
            • Checkpoint-info-list
            • Previous-subsumer-hints
            • Fms!-lst
            • Zp-listp
            • Doublets-to-alist
            • Trans-eval-state
            • Injections
            • Theorems-about-osets
            • Typed-list-utilities
            • Book-runes-alist
            • User-interface
            • Bits/ubyte11s-digit-grouping
            • Bits/bytes-digit-grouping
            • Message-utilities
            • Subsetp-eq-linear
            • Strict-merge-sort-<
            • Miscellaneous-enumerations
            • Maybe-unquote
            • Oset-utilities
            • Thm<w
            • Defthmd<w
          • Prime-field-constraint-systems
          • Soft
          • Bv
          • Imp-language
          • Event-macros
          • Bitcoin
          • Ethereum
          • Yul
          • Zcash
          • ACL2-programming-language
          • Prime-fields
          • Java
          • C
          • Syntheto
          • Number-theory
          • Cryptography
          • Lists-light
          • File-io-light
          • Json
          • Built-ins
          • Solidity
          • Axe
          • Std-extensions
          • Htclient
          • Typed-lists-light
          • Arithmetic-light
        • X86isa
        • Execloader
        • Axe
      • Testing-utilities
      • Math
    • Kestrel-utilities

    Skip-in-book

    Skip a form when executing certify-book or include-book

    The utility skip-in-book takes a single argument, which is a form to be evaluated except during a call of certify-book or include-book. Thus, by placing an expression (skip-in-book <form>) in a book, say foo.lisp, you are arranging that evaluation of <form> is skipped when certifying or including foo.lisp. However, <form> will be evaluated if you submit (skip-in-book <form>) to the top-level loop, for example by evaluating (ld "foo.lisp").

    (Technically, the criterion for skipping the form is that either some book is being certified or (ld-skip-proofsp state) is 'include-book. The latter holds when including a book, whether certified or not.)

    To use this utility, you must both include the book in which it is defined and then install it, as follows.

    (include-book "kestrel/utilities/skip-in-book" :dir :system)
    (install-skip-in-book)

    Let us consider an example in which the contents of the book foo.lisp are as follows.

    (in-package "ACL2")
    
    (include-book "kestrel/utilities/skip-in-book" :dir :system)
    (install-skip-in-book)
    
    (defun good-fn (x)
      (cons x x))
    
    (skip-in-book
     (defun bad-fn (x)
       (cons x x)))
    
    (skip-in-book
     (set-guard-checking nil))

    When you certify or include this book, the last two forms will be skipped, and thus bad-fn will not be defined and guard-checking will be unchanged. But when you execute (ld "foo.lisp"), you will be defining bad-fn and also you will see that guard-checking has transitioned to nil.