tldr/pages/common/idnits.md

26 lines
727 B
Markdown
Raw Normal View History

2021-05-27 23:29:26 +01:00
# idnits
> Check internet-drafts for submission nits.
> Looks for violations of Section 2.1 and 2.2 of the requirements listed on <https://www.ietf.org/id-info/checklist>.
> More information: <https://github.com/ietf-tools/idnits>.
2021-05-27 23:29:26 +01:00
- Check a file for nits:
`idnits {{path/to/file.txt}}`
- Count nits without displaying them:
`idnits --nitcount {{path/to/file.txt}}`
- Show extra information about offending lines:
`idnits --verbose {{path/to/file.txt}}`
- Expect the specified year in the boilerplate instead of the current year:
`idnits --year {{2021}} {{path/to/file.txt}}`
- Assume the document is of the specified status:
`idnits --doctype {{standard|informational|experimental|bcp|ps|ds}} {{path/to/file.txt}}`