search

ietf-tools / idnits

Library / CLI to inspect Internet-Draft documents for a variety of conditions to conform with IETF policies.
BSD 3-Clause "New" or "Revised" License
11 stars 16 forks source link

FILENAME_MISSING_COMPONENTS is based on advice, not a rule #32

Open paulehoffman opened 6 months ago

paulehoffman commented 6 months ago

draft-rswg-rfc7997bis is draft in the RSWG, and the filename is completely legal. The description of "Filename must consists of at least 4 components" does not match some of the names described on https://authors.ietf.org/naming-your-internet-draft.

This file also gets FILENAME_INVALID_VERSION_SUFFIX and FILENAME_DOCNAME_MISMATCH errors, which is probably queued off of the above. The docname in the file is draft-rswg-rfc7997bis-02, which has a valid version suffix.

markusa commented 4 months ago

Same problem here. I want to use idnits with github workflows to integrate it into the automatic build process from Markdown to XML/TXT/HTML.

However, idnits v3 complains about the filename of draft-ietf-tsvwg-multipath-dccp.txt, which is the input file, and refuses further action. If this is desired, it would at least be good to have this strict file name check configurable.

 FAIL  Document is INVALID. ❌

 1  Error
 └- Code - FILENAME_INVALID_VERSION_SUFFIX
 └- Desc - Filename must end with a version in format 00.
 └- Ref  - https://authors.ietf.org/naming-your-internet-draft

 2  Error
 └- Code - FILENAME_DOCNAME_MISMATCH
 └- Desc - Filename does not match the name declared in the document.
 └- Ref  - https://authors.ietf.org/naming-your-internet-draft

A run of https://raw.githubusercontent.com/tsvwg/ietf-multipath-dccp/master/draft-ietf-tsvwg-multipath-dccp.mkd with https://author-tools.ietf.org/idnits, which actually uses idnits 2.17.1, only throws a warning, which is sufficient in my opinion.

  == Mismatching filename: the document gives the document name as
     'draft-ietf-tsvwg-multipath-dccp-15', but the file name used is
     'draft-ietf-tsvwg-multipath-dccp'