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
12 stars 16 forks source link

Clarifying MISSING_REFERENCES_TITLE lint #29

Open wiktor-k opened 9 months ago

wiktor-k commented 9 months ago

Hi,

I'm trying out idnits v3 (3.0.0-alpha.33) and it works great but there's one lint I'm wondering about:

2  Error
 └- Code - MISSING_REFERENCES_TITLE
 └- Desc - The references section is missing a title attribute.
 └- Ref  - https://authors.ietf.org/required-content#references
 └- Path - rfc.back.references[0].title

I've been looking through the already published RFCs but the <reference> tags seem to be missing titles there too:

$ curl -sSL https://www.rfc-editor.org/rfc/rfc8949.xml | grep '<references'
    <references pn="section-11">
      <references pn="section-11.1">
      <references pn="section-11.2">

Where can I learn more about the title attribute and the reasoning for this lint?

(Context: I'm producing the XML from Markdown via mmark but before I submit an issue there I'd like to understand the reasoning).

Thank you for your time! :wave:

NGPixel commented 9 months ago

This is indeed a bug.

It should be looking for a <name> element under <references> instead of a title attribute.