Re: [netmod] List name: singular or plural?

Carsten Bormann <cabo@tzi.org> Tue, 29 August 2023 20:10 UTC

Return-Path: <cabo@tzi.org>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id EA6B1C13AE44 for <netmod@ietfa.amsl.com>; Tue, 29 Aug 2023 13:10:02 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.906
X-Spam-Level:
X-Spam-Status: No, score=-1.906 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_BLOCKED=0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id qg0fLHoUITGx for <netmod@ietfa.amsl.com>; Tue, 29 Aug 2023 13:09:58 -0700 (PDT)
Received: from smtp.zfn.uni-bremen.de (smtp.zfn.uni-bremen.de [IPv6:2001:638:708:32::21]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 933C8C151096 for <netmod@ietf.org>; Tue, 29 Aug 2023 13:09:58 -0700 (PDT)
Received: from [192.168.217.124] (p548dc15c.dip0.t-ipconnect.de [84.141.193.92]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4RZz6r4x3xzDCcL; Tue, 29 Aug 2023 22:09:56 +0200 (CEST)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.7\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <CEDB5A30-7500-4C50-ABB5-E676649B2C47@cisco.com>
Date: Tue, 29 Aug 2023 22:09:56 +0200
Cc: netmod <netmod@ietf.org>
X-Mao-Original-Outgoing-Id: 715032596.186668-25357f15d58367e3bc507b5f8214659f
Content-Transfer-Encoding: quoted-printable
Message-Id: <00AC999F-F0CF-488A-BB91-2B0EB788174B@tzi.org>
References: <DB29E247-E2BE-4D52-94A7-81B8010EDCD7@tzi.org> <CEDB5A30-7500-4C50-ABB5-E676649B2C47@cisco.com>
To: "Jan Lindblad (jlindbla)" <jlindbla@cisco.com>
X-Mailer: Apple Mail (2.3608.120.23.2.7)
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/qCSQZPEruNE_00fIqD-QIrX5gV8>
Subject: Re: [netmod] List name: singular or plural?
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: NETMOD WG list <netmod.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netmod>, <mailto:netmod-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod/>
List-Post: <mailto:netmod@ietf.org>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netmod>, <mailto:netmod-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 29 Aug 2023 20:10:03 -0000

On 2023-08-29, at 22:00, Jan Lindblad (jlindbla) <jlindbla@cisco.com> wrote:
> 
> Carsten,
> 
>> Should list names be singular or plural?
> 
> The convention is to have the list name singular, and surrounding container name plural.

Thank you.

Now I still would like a link to a document that explains all this...

> A quick grep across IETF RFC YANG modules for list names ending in s versus ending with other letters gave 370 vs 1663 = ~20% (some modules may have been scanned more than once, due to multiple versions etc).

Quick checks like this always help to determine what usage is prevailing, thanks!
Is there a good place where I can rsync IETF YANG modules from?

> For some transport encodings (e.g. XML), the surrounding container makes the list contents a bit more manageable. A surrounding container is also a convenient for use in filters and NACM rules.

The specific reason for asking this question is for draft-ietf-core-sid [1], where we used singular list names, but the PYANG sid plugin creates files with a few plural names in them.  (Quickly worked around with some robustness in the sid-csv tool…)
Since this is not data-at-rest (*), I don’t think a container would add anything.

Grüße, Carsten

(*) It may seem a bit weird to call a specification file data-in-flight, but that is what a specification is — a message, here even using sx:structure.
[1]: https://www.ietf.org/archive/id/draft-ietf-core-sid-20.html