RFC Errata


Errata Search

 
Source of RFC  
Summary Table Full Records

Found 1 record.

Status: Held for Document Update (1)

RFC 7322, "RFC Style Guide", September 2014

Source of RFC: IAB

Errata ID: 5076

Status: Held for Document Update
Type: Technical

Reported By: John Klensin
Date Reported: 2017-08-02
Held for Document Update by: Robert Sparks
Date Held: 2017-08-09

Section 4.3 says:

Every RFC must have an Abstract that provides a concise and 
comprehensive overview ...
[...]
Similarly, the Abstract should be complete in itself.  It will appear
in isolation in publication announcements and in the online index 
of RFCs. Therefore, the Abstract must not contain citations.

It should say:

   (Because this document is already being revised and there are 
   more fundamental issues involved than simple textual changes,
   the optimal fix for these issues should be left to the 
   discretion of the RFC Editor.)

Notes:

While the intent seems to me to be clear, this subsection can be read to contradict both other "preferences" and that intent. For example, "comprehensive", when taken out of the context of the text that follows (as it appears to have recently been taken by an AD acting in official capacity [1] [2]) can be used to insist that the abstract contain copies of extracts of almost any part of a well-written document, thereby defeating the purpose of an abstract and violating the RFC Editor's historical "no more than 13 lines" guidance (which does not appear in this RFC).

In addition, the prohibition on citations has often been taken as a prohibition on explicit citation anchors. But, if the intent is to be sure that abstracts are self-contained, any mention of another document by reference, without context appropriate to abstracts explaining what they document is about, is a citation. For example, the statement (from the abstract of this document) 'This document obsoletes RFC 2223, "Instructions to RFC Authors"' is plausible in an abstract because it is clear to the reader what RFC 2223 is about although one could reasonably argue for different presentation. By contract, a statement such as "This document obsoletes RFC 4637" should not be acceptable because it not only contains a citation (even if the explicit anchor is absent) but has no actual meaning unless the number is very well-known (i.e., meets criteria roughly equivalent to those for common abbreviations in section 3.6) or the reader tracks the citation down, violating the "complete in itself" principle. If readers of this submission do not immediately recognize "4637" and associate it with important other issues, Q.E.D.

I note that prohibitions of statements like "This document obsoletes RFC 4637" or "This document makes RFC 7 Historic" appear to contradict popular interpretations of an IESG statement [3]. That further suggests that either this subsection is in need of further clarification or that the RFC Editor and IESG have some sorting out to do.

-----
[1] https://www.ietf.org/mail-archive/web/urn/current/msg03783.html
[2] https://www.ietf.org/mail-archive/web/urn/current/msg03784.html
[3] https://www.ietf.org/iesg/statement/designating-rfcs-as-historic-2011-06-27.html

Report New Errata



Search RFCs
Advanced Search
×