[Extra] BCP 178/X- convention (was AD Review of draft-ietf-extra-imap4rev2)

Alexey Melnikov <alexey.melnikov@isode.com> Mon, 04 January 2021 18:26 UTC

Return-Path: <alexey.melnikov@isode.com>
X-Original-To: extra@ietfa.amsl.com
Delivered-To: extra@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 6A0013A0EF6 for <extra@ietfa.amsl.com>; Mon, 4 Jan 2021 10:26:38 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -0.198
X-Spam-Level:
X-Spam-Status: No, score=-0.198 tagged_above=-999 required=5 tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, HTML_MESSAGE=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=isode.com
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 nn7r5Ozlo6Ib for <extra@ietfa.amsl.com>; Mon, 4 Jan 2021 10:26:37 -0800 (PST)
Received: from statler.isode.com (Statler.isode.com [62.232.206.189]) by ietfa.amsl.com (Postfix) with ESMTP id BDC6B3A0FCA for <extra@ietf.org>; Mon, 4 Jan 2021 10:26:35 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; t=1609784794; d=isode.com; s=june2016; i=@isode.com; bh=BFEa+md6o2XSPQwCbuN9mRQhyoSXFjz51GECgIslxeE=; h=From:Sender:Reply-To:Subject:Date:Message-ID:To:Cc:MIME-Version: In-Reply-To:References:Content-Type:Content-Transfer-Encoding: Content-ID:Content-Description; b=TeN+s3y9o3rs3DQLn1z8OBiuFshSLNSbo8ruLemHws2Nnfnb/0/v+crU2qchDEmjvy6j2T TrtK8yuL5nuaNlRDGUMVC6CJz9xSSwnRNvlXdXCNYrYifumAdNI6OKdMbi2Ne9q0hH7Rnc RxFjsPIRFD5aCOR788PLgx9Rva/F0CI=;
Received: from [172.27.255.49] (connect.isode.net [172.20.0.72]) by statler.isode.com (submission channel) via TCP with ESMTPSA id <X=Nd2gBqmiE4@statler.isode.com>; Mon, 4 Jan 2021 18:26:34 +0000
To: "Murray S. Kucherawy" <superuser@gmail.com>, Barry Leiba <barryleiba@computer.org>
References: <CAL0qLwaLa+PuGWRrKTbpmDa_SWKT9ZQUEQ9dsPgXfUmTzcYAYw@mail.gmail.com>
From: Alexey Melnikov <alexey.melnikov@isode.com>
Cc: extra@ietf.org
Message-ID: <82bda3f6-4629-42ea-bfa5-94551b7a721f@isode.com>
Date: Mon, 04 Jan 2021 18:26:33 +0000
User-Agent: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:78.0) Gecko/20100101 Thunderbird/78.5.0
In-Reply-To: <CAL0qLwaLa+PuGWRrKTbpmDa_SWKT9ZQUEQ9dsPgXfUmTzcYAYw@mail.gmail.com>
MIME-Version: 1.0
Content-Type: multipart/alternative; boundary="------------99A16D5A82CD2AE521AAE51C"
Content-Language: en-GB
Archived-At: <https://mailarchive.ietf.org/arch/msg/extra/zqeqfWBcyhwrc9-V4spRvHp35g4>
Subject: [Extra] BCP 178/X- convention (was AD Review of draft-ietf-extra-imap4rev2)
X-BeenThere: extra@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Email mailstore and eXtensions To Revise or Amend <extra.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/extra>, <mailto:extra-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/extra/>
List-Post: <mailto:extra@ietf.org>
List-Help: <mailto:extra-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/extra>, <mailto:extra-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 04 Jan 2021 18:26:38 -0000

Hi Murray/Barry,

I've extracted all of your comments related to BCP 178 ("X- convention 
considered harmful):

On 04/01/2021 08:18, Murray S. Kucherawy wrote:
>
> Section 6.1.1
>
>
> Is the stuff about XBLURDYBLOOP still appropriate given BCP 178?
>
I deleted this text, as it really belongs to future revision of RFC 4422 
(SASL), if at all.

> Section 6.3.1
>
> There’s another “X” reference here (BCP 178).
>
>
This is section defines the ENABLE command. The example is using 
X-GOOD-IDEA as an example of a fictitious capability that can be 
enabled. Use of X-GOOD-IDEA in the example is not critical, but it makes 
it more explicit that this is not registered. I can change the example.

>   In this example, a server supports 2 Personal Namespaces.  …
>
>
> There’s a reference to X-PARAM in here that probably needs updating in 
> light of BCP 178.
>
Here, I think we need to use an unregistered parameter. It doesn't have 
to be X-PARAM, but X-PARAM seems a bit more obvious due to old usage, 
even if it is considered wrong these days.


> Section 6.5
>
> Is this appropriate in light of BCP 178?
>
So this section is titled "Client Commands - Experimental/Expansion" and 
talks in general terms about implementation specific commands (that were 
required to start with "X" in RFC 3501) and some generic requirements on 
clients/servers in regards to extensions. I can extract useful text 
about the latter and drop the former.
>
> Section 7.2.2
>
>
> The stuff about capability names starting with “X” should be reviewed 
> in light of BCP 178.
>
This section is titled "CAPABILITY Response". Below is the offending text:

    Capability names MUST either begin with "X" or be informational,
    experimental or standards-track IMAP4rev2 extensions, revisions, or
    amendments registered with IANA.

Dropping "X" from the above list would be fine with me. But this raises 
a related question: should this document allow Experimental RFCs outside 
of IETF stream in order to encourage people to document their private 
extensions?

    A server SHOULD NOT offer
    unregistered or non-standard capability names, unless such names are
    prefixed with an "X".

This probably should be dropped.

Best Regards,

Alexey