[quicwg/base-drafts] Don't use bitmap frames to describe varint structures (#3115)

"Roy T. Fielding" <notifications@github.com> Thu, 17 October 2019 19:56 UTC

Return-Path: <noreply@github.com>
X-Original-To: quic-issues@ietfa.amsl.com
Delivered-To: quic-issues@ietfa.amsl.com
Received: from localhost (localhost []) by ietfa.amsl.com (Postfix) with ESMTP id 485F61200FA for <quic-issues@ietfa.amsl.com>; Thu, 17 Oct 2019 12:56:47 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -6.382
X-Spam-Status: No, score=-6.382 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HTML_IMAGE_ONLY_24=1.618, HTML_MESSAGE=0.001, MAILING_LIST_MULTI=-1, RCVD_IN_DNSWL_HI=-5, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=github.com
Received: from mail.ietf.org ([]) by localhost (ietfa.amsl.com []) (amavisd-new, port 10024) with ESMTP id sNqLVNCmbuiD for <quic-issues@ietfa.amsl.com>; Thu, 17 Oct 2019 12:56:40 -0700 (PDT)
Received: from out-5.smtp.github.com (out-5.smtp.github.com []) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 9E77B120241 for <quic-issues@ietf.org>; Thu, 17 Oct 2019 12:56:40 -0700 (PDT)
Received: from github-lowworker-45eca55.ac4-iad.github.net (github-lowworker-45eca55.ac4-iad.github.net []) by smtp.github.com (Postfix) with ESMTP id AA3B0960357 for <quic-issues@ietf.org>; Thu, 17 Oct 2019 12:56:39 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=github.com; s=pf2014; t=1571342199; bh=V7K6LfBXmmZf2U3ts0JRPOPr9RxVp9zi11EgYpu2yQs=; h=Date:From:Reply-To:To:Cc:Subject:List-ID:List-Archive:List-Post: List-Unsubscribe:From; b=dNqissZ/PUF4GfoARdELu8dhn8+GxiKdV7OMBXW217/NbRI5wFNtEWgUk2sKm9DrM EyPIN9d3oDh3FYKDLybwkUGDn95aB6DdKytQPygAVzK/+CG/LrN4FisdL3W66qDpar 17uJPWq1SVRgLSy/0SnUXl4SxDHKq7Gd7paT6/ic=
Date: Thu, 17 Oct 2019 12:56:39 -0700
From: "Roy T. Fielding" <notifications@github.com>
Reply-To: quicwg/base-drafts <reply+AFTOJKYXW6AGAZBMXIAA2Y53WYEAPEVBNHHB4UPZEI@reply.github.com>
To: quicwg/base-drafts <base-drafts@noreply.github.com>
Cc: Subscribed <subscribed@noreply.github.com>
Message-ID: <quicwg/base-drafts/issues/3115@github.com>
Subject: [quicwg/base-drafts] Don't use bitmap frames to describe varint structures (#3115)
Mime-Version: 1.0
Content-Type: multipart/alternative; boundary="--==_mimepart_5da8c7779bd27_57c83fcee82cd96c160962"; charset="UTF-8"
Content-Transfer-Encoding: 7bit
Precedence: list
X-GitHub-Sender: royfielding
X-GitHub-Recipient: quic-issues
X-GitHub-Reason: subscribed
X-Auto-Response-Suppress: All
X-GitHub-Recipient-Address: quic-issues@ietf.org
Archived-At: <https://mailarchive.ietf.org/arch/msg/quic-issues/Xzm8iBjyG7UEju23qz9yPzoRPqQ>
X-BeenThere: quic-issues@ietf.org
X-Mailman-Version: 2.1.29
List-Id: Notification list for GitHub issues related to the QUIC WG <quic-issues.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/quic-issues>, <mailto:quic-issues-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/quic-issues/>
List-Post: <mailto:quic-issues@ietf.org>
List-Help: <mailto:quic-issues-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/quic-issues>, <mailto:quic-issues-request@ietf.org?subject=subscribe>
X-List-Received-Date: Thu, 17 Oct 2019 19:56:47 -0000

Many of the QUIC drafts use fixed 32bit maps to "illustrate" the layout of various parts of a message. In some cases, that is useful up to the point where the frame bits end. In other cases, the illustration consists of a list of arbitrary varint values, for which the 32bit illustration is both horribly misleading and a waste of space (and reader's time). Please stop.

I prefer C-style data structures for descriptive ordering, but YMMV. The simplest alternative is to just list the variable names (and types) in order. The only place where I would like to see a bitmap presentation would be an actual example, which shows the variable ints in the actual positions that the example values would cause them to be placed.

You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub: