RFC Errata: when to file, and when not to

Barry Leiba <barryleiba@computer.org> Tue, 31 July 2012 23:27 UTC

Return-Path: <barryleiba@gmail.com>
X-Original-To: ietf@ietfa.amsl.com
Delivered-To: ietf@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id C8C5711E8137 for <ietf@ietfa.amsl.com>; Tue, 31 Jul 2012 16:27:59 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -102.959
X-Spam-Level:
X-Spam-Status: No, score=-102.959 tagged_above=-999 required=5 tests=[AWL=0.017, BAYES_00=-2.599, FM_FORGED_GMAIL=0.622, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_LOW=-1, USER_IN_WHITELIST=-100]
Received: from mail.ietf.org ([12.22.58.30]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Yz94DasTH3O0 for <ietf@ietfa.amsl.com>; Tue, 31 Jul 2012 16:27:59 -0700 (PDT)
Received: from mail-pb0-f44.google.com (mail-pb0-f44.google.com [209.85.160.44]) by ietfa.amsl.com (Postfix) with ESMTP id 196C111E80FA for <ietf@ietf.org>; Tue, 31 Jul 2012 16:27:59 -0700 (PDT)
Received: by pbbjt11 with SMTP id jt11so43259pbb.31 for <ietf@ietf.org>; Tue, 31 Jul 2012 16:27:58 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:sender:date:x-google-sender-auth:message-id:subject :from:to:content-type; bh=Yb6foeIbBJ5K6y24+/5v4twmVKP6KJnLrWOMtU/5sMg=; b=YhT5ghsfsGmE8rcSrGrtbylYxNMCWQQ7wG5UabuSXdE/TNRD6DLmUUYbdwmDtoONgt YENA9EYUY0Cr4aETSfjxUUf42RaNHD589e6b8Hw/Zgnv8yW0Q+ZFnoBVv1EB0/9XNozf UmBjvKBXdSA6shcfdyRGB555HgWWfV2sJD/kokXK7shfihYvDSi684U5aQJII9ow72rK uOmM+cWHy8OodT/PajeumrCPEDEHXyKwNIMiLK9UDSzTN2ndBCQNXxX8Ikmhrgvqsnmg WQeBJ1sTR39xP4yMS0cVQlPhIosQGbLPALUH/b7JV2Ye5Gzm7lPOAPzh1ekhuIM4vTJi F+bg==
MIME-Version: 1.0
Received: by 10.66.89.170 with SMTP id bp10mr35743095pab.12.1343777278903; Tue, 31 Jul 2012 16:27:58 -0700 (PDT)
Sender: barryleiba@gmail.com
Received: by 10.68.64.103 with HTTP; Tue, 31 Jul 2012 16:27:58 -0700 (PDT)
Date: Tue, 31 Jul 2012 19:27:58 -0400
X-Google-Sender-Auth: yjCovhzDqvzbeRsVeChexfmIzrM
Message-ID: <CALaySJKV96tdXhzfPD1e1Mro_+gp5aDarF7Z06QrA+iQtnHkLw@mail.gmail.com>
Subject: RFC Errata: when to file, and when not to
From: Barry Leiba <barryleiba@computer.org>
To: IETF discussion list <ietf@ietf.org>
Content-Type: multipart/alternative; boundary="f46d04289c895dc51d04c628870c"
X-BeenThere: ietf@ietf.org
X-Mailman-Version: 2.1.12
Precedence: list
List-Id: IETF-Discussion <ietf.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/ietf>, <mailto:ietf-request@ietf.org?subject=unsubscribe>
List-Archive: <http://www.ietf.org/mail-archive/web/ietf>
List-Post: <mailto:ietf@ietf.org>
List-Help: <mailto:ietf-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/ietf>, <mailto:ietf-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 31 Jul 2012 23:27:59 -0000

We've been seeing a lot of inappropriate errata reports, made by
well-meaning people who, surely, think their reports are useful, even
important.  These aren't free: they take time to process, and they form
clutter in the errata system, obscuring the ones that do fit into what
errata are meant to be.

So I wanted to clarify what's meant to be reported, and what's not.

A valid erratum, one that the IESG will mark as "Verified", mets two
criteria:

1. It is truly an *error* in the original document.  That is, it would have
been considered an error *at the time the document was published*, had it
been noticed at the time.

2. It is important, an error that would cause someone to misread the
document in a significant way, causing implementation or deployment
problems, or other serious issues.

Criterion 1 means that anything that is "wrong" because of situations or
discussions that have come up since publication are not appropriate errata.
 Consider the differences among these:

- (a) Someone realizes that the document forgot to specify the valid range
of a value.

- (b) Someone realizes that the range specified did not correctly reflect
the result of the discussion at the time (the change got missed and no one
noticed).

- (c) Someone realizes that the range specified causes problems in
practice, but we didn't know that would happen when we published the
document.

(a) and (b) are valid errata, and should get marked as "Verified".  (c) is
NOT valid for the errata system, and really ought to be marked as
"Rejected".

Criterion 2 means that minor typos are NOT appropriate errata.  The IESG
will mark these as "Held for Document Update", but, really, there is no
need to say that "an" should be "and", that a comma is missing (unless it
seriously affects the meaning and is likely to be mis-read), or that
"concensus" is misspelled (as here).  Again, consider the differences:

- (a) "The server will now respond with an error code," where "now" should
have been "not".

- (b) "The server will not repond with an error code," where "repond"
should have been "respond".

- (c) "The server will not respond with and error code," where "and" should
have been "an".

(a) is the only valid one here.  There's no real value in recording the
others as errata.

In particular, the errata system is NOT meant to be used as an issue
tracker; please do not submit errata reports with the *intent* that they be
marked as "Held for Document Update", to be used as an issue list later.
 We have mailing lists, issue trackers, and wikis for this purpose.

Barry, Applications AD