Re: [OPSAWG] New Version Notification for draft-tuexen-opsawg-pcapng-02.txt

Carsten Bormann <cabo@tzi.org> Wed, 30 September 2020 12:54 UTC

Return-Path: <cabo@tzi.org>
X-Original-To: opsawg@ietfa.amsl.com
Delivered-To: opsawg@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 454C23A0475 for <opsawg@ietfa.amsl.com>; Wed, 30 Sep 2020 05:54:16 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.887
X-Spam-Level:
X-Spam-Status: No, score=-1.887 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_PDS_OTHER_BAD_TLD=0.01, 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 5eY8Y6PHxq97 for <opsawg@ietfa.amsl.com>; Wed, 30 Sep 2020 05:54:13 -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 07BC13A041B for <opsawg@ietf.org>; Wed, 30 Sep 2020 05:54:12 -0700 (PDT)
Received: from [192.168.217.118] (p548dcc60.dip0.t-ipconnect.de [84.141.204.96]) (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 4C1bmf6qKGzyZg; Wed, 30 Sep 2020 14:54:10 +0200 (CEST)
Content-Type: text/plain; charset=utf-8
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.4\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <E9721F8A-B0D9-4D9A-8FB8-BD7C185A6F76@sonic.net>
Date: Wed, 30 Sep 2020 14:54:10 +0200
Cc: Michael Tuexen <tuexen@fh-muenster.de>, Gerald Combs <gerald@wireshark.org>, pcap-ng-format@winpcap.org, Jasper Bongertz <jasper@packet-foo.com>, tcpdump-workers@lists.tcpdump.org, opsawg@ietf.org, Fulvio Risso <fulvio.risso@polito.it>
X-Mao-Original-Outgoing-Id: 623163250.253036-8a43be9e78bbd1a605db6cf9b7268f3e
Content-Transfer-Encoding: quoted-printable
Message-Id: <7385AABB-8AD8-4CE6-A2D0-18769ABAF9BB@tzi.org>
References: <160131683320.30001.4858487168061369615@ietfa.amsl.com> <31134.1601317608@localhost> <100954A4-FAA0-4E40-B592-5F208DAB5F68@fh-muenster.de> <E9721F8A-B0D9-4D9A-8FB8-BD7C185A6F76@sonic.net>
To: Guy Harris <gharris@sonic.net>
X-Mailer: Apple Mail (2.3608.120.23.2.4)
Archived-At: <https://mailarchive.ietf.org/arch/msg/opsawg/JyM2zfFKHdRexFi6_IryIFtGHo4>
Subject: Re: [OPSAWG] New Version Notification for draft-tuexen-opsawg-pcapng-02.txt
X-BeenThere: opsawg@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: OPSA Working Group Mail List <opsawg.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/opsawg>, <mailto:opsawg-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/opsawg/>
List-Post: <mailto:opsawg@ietf.org>
List-Help: <mailto:opsawg-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/opsawg>, <mailto:opsawg-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 30 Sep 2020 12:54:16 -0000

(Keeping CC list, so I’ll probably reach people and not lists.)

> On 2020-09-28, at 22:41, Guy Harris <gharris@sonic.net> wrote:
> 
> There are tools to convert Markdown to v2 or v3 RFC XML:
> 
> 	https://www.rfc-editor.org/pubprocess/tools/

This is a list of very, very different tools.  Some of these are useful for a “conversion” (as a one-time effort), some are meant to be used in a publishing pipeline where people rarely see the “object file” that happens to be in XML (e.g., mmark and kramdown-rfc).

> so:
> 
> 	1) is it easier to edit Markdown or RFC XML?

I wrote kramdown-rfc a decade ago when I had two days to write six drafts.

I gambled that spending one day on the tool and one day on writing markdown would be quicker than spending two days on writing XML.  

I won.

This was meant as a personal tool to get work done (and, boy, did it speed up my work), but it has found some other users; approximately 20 % of all Internet-Drafts are currently being written in kramdown-rfc (approximately 2 % use mmark).

> 	2) is Markdown rich enough to do everything we want to do?

No.  So there are some additions.

> For 2), I note that
> 
> 	https://github.com/pcapng/pcapng/blob/master/draft-tuexen-opsawg-pcapng.md
> 
> has a bunch of stuff that GitHub isn't treating as markup, such as the stuff prior to the "Introduction" heading, and the tags such as "{::boilerplate bcp14}".  Is that an extension of Markdown not supported by GitHub's Markdown renderer but supported by some Markdown-to-RFC XML converter,

Yes.

(I have since sent Michael an automatically upconverted markdown version of the XML, BTW.)

> In addition, the XML version at
> 
> 	https://github.com/pcapng/pcapng/blob/master/reference-draft-tuexen-opsawg-pcapng.xml
> 
> has some additional Decryption Secrets Block secret formats.  Those have data formats that *themselves* call for figures, and I'd been trying, at one point, to determine how to do that in RFC XML v2 format - it might require v3 format.  Can that be handled with Markdown?

You can always fall back to XML inside the markdown, but that is rarely needed.

As an example for a slightly automated form of writing, RFC 7400 was written in markdown, with a significant part of the text generated automatically from a Makefile; this text is then included using the {::include …} construct of kramdown-rfc.

Some resources:
http://rfc.space
http://slides.rfc.space
https://www.ietf.org/mailman/listinfo/rfc-markdown

Grüße, Carsten