[fdt] Fwd: I-D Action: draft-petithuguenin-computerate-specifying-14.txt

Marc Petit-Huguenin <marc@petit-huguenin.org> Mon, 11 October 2021 17:06 UTC

Return-Path: <marc@petit-huguenin.org>
X-Original-To: fdt@ietfa.amsl.com
Delivered-To: fdt@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 3EC8B3A0DC9 for <fdt@ietfa.amsl.com>; Mon, 11 Oct 2021 10:06:25 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_FAIL=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 8IyycLHZ4LVZ for <fdt@ietfa.amsl.com>; Mon, 11 Oct 2021 10:06:19 -0700 (PDT)
Received: from implementers.org (implementers.org [92.243.22.217]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 2BA8E3A0DD7 for <fdt@ietf.org>; Mon, 11 Oct 2021 10:06:18 -0700 (PDT)
Received: from [IPv6:2601:204:e600:411:d250:99ff:fedf:93cd] (unknown [IPv6:2601:204:e600:411:d250:99ff:fedf:93cd]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-384) server-signature RSA-PSS (2048 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "Marc Petit-Huguenin", Issuer "implementers.org" (verified OK)) by implementers.org (Postfix) with ESMTPS id 4AA6FAE536 for <fdt@ietf.org>; Mon, 11 Oct 2021 19:06:11 +0200 (CEST)
References: <163397047996.10354.17285931829891402982@ietfa.amsl.com>
From: Marc Petit-Huguenin <marc@petit-huguenin.org>
To: "fdt@ietf.org" <fdt@ietf.org>
X-Forwarded-Message-Id: <163397047996.10354.17285931829891402982@ietfa.amsl.com>
Message-ID: <365c3391-a103-e430-c37c-e5948b998c0f@petit-huguenin.org>
Date: Mon, 11 Oct 2021 10:06:09 -0700
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.14.0
MIME-Version: 1.0
In-Reply-To: <163397047996.10354.17285931829891402982@ietfa.amsl.com>
Content-Type: text/plain; charset="utf-8"; format="flowed"
Content-Language: en-US
Content-Transfer-Encoding: 8bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/fdt/fuIl6neePsSoKIPE4c8RvAFcBlI>
Subject: [fdt] Fwd: I-D Action: draft-petithuguenin-computerate-specifying-14.txt
X-BeenThere: fdt@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Mailing list for the discussion of the use of formal description techniques in IETF documents <fdt.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/fdt>, <mailto:fdt-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/fdt/>
List-Post: <mailto:fdt@ietf.org>
List-Help: <mailto:fdt-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/fdt>, <mailto:fdt-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 11 Oct 2021 17:06:26 -0000

A computerate specification can be seen as a way to bring together the tools that are used to author an Internet-Draft, with the goal of making that Internet-Draft better.  In a way a computerate specification acts as a bridge between these tools and the various formalism present in an RFC, formalism that various people will use to implement and test IETF protocols.

Although it is not the first of these formalism to be part of the tooling (that would be TPN), version -14 is the first version that contains the tools to define an ABNF and render it in the document, with the guarantee that the ABNF is syntactical correct.  Note that the philosophy behind a computerate specification is not to run validations tools (like the various ABNF validation tools at https://tools.ietf.org/) when the document is built, but to ensure that the ABNF is correct in the first place, and so running these tools against the ABNF is unnecessary.  Validation -- much like code testing -- can, and will be, skipped; correctness by construction cannot.

I will be submitting a new draft in few hours that is intensively using that technique to define its ABNF.

Version -14 is also meant to help people getting started writing computerate specifications with an improved Appendix A (that should contains all the instructions to get started), and the availability of a template in the Docker image.

Questions, comments, and suggestions can be sent here or directly to my email address.  I am also available on hallway@jabber.ietf.org/MPH.

Happy specifying...

-------- Forwarded Message --------
Subject: I-D Action: draft-petithuguenin-computerate-specifying-14.txt
Date: Mon, 11 Oct 2021 09:41:20 -0700
From: internet-drafts@ietf.org
Reply-To: internet-drafts@ietf.org
To: i-d-announce@ietf.org


A New Internet-Draft is available from the on-line Internet-Drafts directories.


         Title           : The Computerate Specifying Paradigm
         Author          : Marc Petit-Huguenin
	Filename        : draft-petithuguenin-computerate-specifying-14.txt
	Pages           : 136
	Date            : 2021-10-11

Abstract:
    This document specifies a paradigm named Computerate Specifying,
    designed to simultaneously document and formally specify
    communication protocols.  This paradigm can be applied to any
    document produced by any Standard Developing Organization (SDO), but
    this document targets specifically documents produced by the IETF.


The IETF datatracker status page for this draft is:
https://datatracker.ietf.org/doc/draft-petithuguenin-computerate-specifying/

There is also an HTML version available at:
https://www.ietf.org/archive/id/draft-petithuguenin-computerate-specifying-14.html

A diff from the previous version is available at:
https://www.ietf.org/rfcdiff?url2=draft-petithuguenin-computerate-specifying-14


Internet-Drafts are also available by anonymous FTP at:
ftp://ftp.ietf.org/internet-drafts/


_______________________________________________
I-D-Announce mailing list
I-D-Announce@ietf.org
https://www.ietf.org/mailman/listinfo/i-d-announce
Internet-Draft directories: http://www.ietf.org/shadow.html
or ftp://ftp.ietf.org/ietf/1shadow-sites.txt

-- 
Marc Petit-Huguenin
Email: marc@petit-huguenin.org
Blog: https://marc.petit-huguenin.org
Profile: https://www.linkedin.com/in/petithug