Re: RFC abbreviations list

Carsten Bormann <cabo@tzi.org> Sun, 26 July 2020 13:05 UTC

Return-Path: <cabo@tzi.org>
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 331C03A0E5E for <ietf@ietfa.amsl.com>; Sun, 26 Jul 2020 06:05:06 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.919
X-Spam-Level:
X-Spam-Status: No, score=-1.919 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_MSPIKE_H4=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id E-XsEL9mHSoa for <ietf@ietfa.amsl.com>; Sun, 26 Jul 2020 06:05:02 -0700 (PDT)
Received: from gabriel-vm-2.zfn.uni-bremen.de (gabriel-vm-2.zfn.uni-bremen.de [134.102.50.17]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 4F1893A0E58 for <ietf@ietf.org>; Sun, 26 Jul 2020 06:05:01 -0700 (PDT)
Received: from [172.16.42.101] (p5089ae91.dip0.t-ipconnect.de [80.137.174.145]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by gabriel-vm-2.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4BF37b6cCmzySy; Sun, 26 Jul 2020 15:04:59 +0200 (CEST)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.1\))
Subject: Re: RFC abbreviations list
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <430f9f29-eadf-b1ee-8914-675b717bc292@joelhalpern.com>
Date: Sun, 26 Jul 2020 15:04:59 +0200
Cc: IETF list <ietf@ietf.org>
X-Mao-Original-Outgoing-Id: 617461499.19963-865b8a7730e476fa3e89933f18df5cb7
Content-Transfer-Encoding: quoted-printable
Message-Id: <9AC082AA-C4A1-40CA-84BF-02C7BD6594D4@tzi.org>
References: <35BE966B-63A2-438F-BD61-570E86ED2E1A@strayalpha.com> <297BF899-553D-44DB-AB56-04280F776F7A@employees.org> <6646575A-E6EA-4B4E-AC1B-F8B84B5A1203@strayalpha.com> <20200724225654.GB43465@faui48f.informatik.uni-erlangen.de> <8F6D2B44-1914-4B3B-9458-3F2BF2CFCA05@tzi.org> <20200725210457.GJ43465@faui48f.informatik.uni-erlangen.de> <9A6BE775-78B9-41C5-A3EE-A34C7D092CA0@tzi.org> <20200725221507.GL43465@faui48f.informatik.uni-erlangen.de> <b8163085-e988-ae6a-e93f-3702f33b0dd0@joelhalpern.com> <20200725225731.GP43465@faui48f.informatik.uni-erlangen.de> <CEA49C2751557DF4896FE6B2@PSB> <DD1FEBD3-4488-419E-A3E7-DC95FABB7F65@tzi.org> <e6d6a42c-e085-e8a1-7c3e-5f7614e3d442@joelhalpern.com> <75C124C8-059F-4A25-8EE7-129241B4A7C7@tzi.org> <430f9f29-eadf-b1ee-8914-675b717bc292@joelhalpern.com>
To: "Joel M. Halpern" <jmh@joelhalpern.com>
X-Mailer: Apple Mail (2.3608.120.23.2.1)
Archived-At: <https://mailarchive.ietf.org/arch/msg/ietf/32zWhLOcor8Io_hkTzEGRC2l5JM>
X-BeenThere: ietf@ietf.org
X-Mailman-Version: 2.1.29
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: <https://mailarchive.ietf.org/arch/browse/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: Sun, 26 Jul 2020 13:05:07 -0000

On 2020-07-26, at 08:11, Joel M. Halpern <jmh@joelhalpern.com> wrote:
> 
> The text above the list states that titles are a judgment call and that they will sometimes allow omission of expansions in titles if the alternative looks too ugly.  Using judgment does seem to be what we want.

Completely agree.  The question is what input is available to make that judgement.  I can’t imagine that the RFC editor is in a good position to judge whether RSASSA-PSS is "well-known and immediately obvious to anyone...”.

So the abbreviation list could serve a purpose recording some of that information.

> Having said that, yes, some periodic housekeeping would seem to be useful.

Indeed.

> My disagreement was with the apparent claim by others that the "*" list ought to be easily updatable by an RFC that issues a new abbreviation. It may be that the person proposing that meant inclusion in the general list, rather than the "*" subset.  Or I may have misudnerstood something even more basic.

I think that an RFC cannot by itself “update” that list.
But just as the RFC editor asks about “keywords” for an RFC, they could indicate/ask about abbreviations used and created.  This would create a conscious point where authors/ADs and RFC editor could interact about moving the list forward.

Grüße, Carsten


> 
> Yours,
> Joel
> 
> On 7/26/2020 1:52 AM, Carsten Bormann wrote:
>> What I was trying to say was that the bar:
>>> that
>>> the abbreviation be well-known and immediately obvious to anyone
>>> with a significant Internet technical or operational background
>>> and experience.
>> … for getting starred is too high.  RSASSA-PSS is also an example how the “starred” list doesn’t really work that well (the RFC title doesn’t expand it although it is not starred), as are many other cases.
>> So the putative criteria is wrong, (partially as a result of that, and partially because the whole concept doesn’t quite work) the list is applied inconsistently, and it seems that there is no uniformity in the result.
>> Looks like something that needs work.
>> Maybe not urgently, but it is one of those pieces of technical debt that come up each time an RFC is published, the main damage being that their titles are often mangled beyond recognition, which makes them harder, not easier, to understand.
>> Giving some regular attention (*) to that list could ease the pain, which is what I was trying to point out.
>> In the end we’ll also need a better policy to handle the expansion issue.
>> Maybe all stuff to do for the RSE-ng, but stuff to do it is.
>> Grüße, Carsten
>> (*) Randomly poking:
>> 6CIO       - 6LoWPAN Capability Indication (6CIO)
>> 6CO        - 6LoWPAN Context Option (6CO)
>> (Both should say “Option”)
>> ARMv4     *- Advanced RISC Machine version 4
>> (This surely shouldn’t be starred under the criteria above, but then it also doesn’t make sense to expand it.  It is used in a single RFC, 6366, in an example.  This is a mid-1990s technology...)
>> Because the > 2500 lines are in no way sourced or even dated, it does not lend itself to divvying up the work to clean this up.  Maybe some mining in the RFCs can help do that, e.g. assigning IETF areas to the abbrevs.  But we need to understand how this list is being used, how the list could be improved to help these use cases, and what the appropriate criteria might be for them.
>