Skip to content

dip-whitelist.txt Documentation

Browse Docs pages

dip-whitelist.txt

Documentation for bones/config/dip-whitelist.txt. This file was auto-generated by the Document Improvement Project (DIP).

Overview

Exact repository-relative documentation paths exempt from DIP's obsolete-document move check. Other audit and stitching behavior still applies.

Details

Configuration file intended to be manually edited or read by Rotkeeper scripts.

Notes

Design

DIP reads exact repository-relative documentation paths, one per line. It trims surrounding whitespace and ignores blank lines and comments starting with #. Listed pages bypass the obsolete-document move check.

Limits

Entries are not globs or directory-prefix rules. The whitelist does not exempt pages from matrix reporting, reference generation, or pillar stitching. It is not a sidecar coverage exception list.

Cautions

A typo does not match the intended page. Keep only current page paths and remove entries when their pages are retired.

Reads and writes

This file is not a script; no script environment contract applies.

Usage

This file has no command-line interface.

History

No matching entries in CHANGELOG.md.