[quicwg/base-drafts] References in Section 12 are awkward (#2165)

Mike Bishop <notifications@github.com> Thu, 13 December 2018 22:15 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 [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 7E547130EAB for <quic-issues@ietfa.amsl.com>; Thu, 13 Dec 2018 14:15:45 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -8.056
X-Spam-Level:
X-Spam-Status: No, score=-8.056 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-1.46, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HTML_IMAGE_ONLY_28=1.404, HTML_MESSAGE=0.001, MAILING_LIST_MULTI=-1, RCVD_IN_DNSWL_HI=-5, 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 ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id RdWCaznuGfHv for <quic-issues@ietfa.amsl.com>; Thu, 13 Dec 2018 14:15:43 -0800 (PST)
Received: from out-5.smtp.github.com (out-5.smtp.github.com [192.30.252.196]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 68EBE130E26 for <quic-issues@ietf.org>; Thu, 13 Dec 2018 14:15:43 -0800 (PST)
Date: Thu, 13 Dec 2018 14:15:42 -0800
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=github.com; s=pf2014; t=1544739342; bh=0yyVJjr4UlNBq4hu1ZbDIatMQDqnXmtL8Bemx12WC1U=; h=Date:From:Reply-To:To:Cc:Subject:List-ID:List-Archive:List-Post: List-Unsubscribe:From; b=0Pr+Ia8ucCioDR9iFr0luiYAI25zh+A6C1K1SxBsrTwcCc/pxHtszWR9ic65FVcU1 zBWngnlQFdAdVlu7lOGSyMG33W2shni1ZtbP42OTT6QpafXt6AJ1XjbP5qFOksCDT0 1883YM8MN74ZqN7Ii8iQD1zrH6WjRqAK7yHghJ+o=
From: Mike Bishop <notifications@github.com>
Reply-To: quicwg/base-drafts <reply+0166e4ab9c2bd95d4e9d55a15e4e08b58580838e3d83b66892cf00000001182a9c0e92a169ce174c67a6@reply.github.com>
To: quicwg/base-drafts <base-drafts@noreply.github.com>
Cc: Subscribed <subscribed@noreply.github.com>
Message-ID: <quicwg/base-drafts/issues/2165@github.com>
Subject: [quicwg/base-drafts] References in Section 12 are awkward (#2165)
Mime-Version: 1.0
Content-Type: multipart/alternative; boundary="--==_mimepart_5c12da0e3eb3d_59c73faeb4cd45b8754f"; charset="UTF-8"
Content-Transfer-Encoding: 7bit
Precedence: list
X-GitHub-Sender: MikeBishop
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/vORAK08rilmREJv3LjbECGqhVoo>
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, 13 Dec 2018 22:15:46 -0000

> Packets that carry the long header are Initial Section 17.5, Retry Section 17.7, Handshake Section 17.6, and 0-RTT Protected packets Section 12.1.

These references should be delimited with parentheses, as is done in the other paragraphs:

> QUIC endpoints communicate by exchanging packets. Packets are carried in UDP datagrams (see Section 12.2) and have confidentiality and integrity protection (see Section 12.1).
>
> This version of QUIC uses the long packet header (see Section 17.2) during connection establishment and the short header (see Section 17.3) once 1-RTT keys have been established.

It also seems odd that our references are to subsections (5, 7, 6) rather than matching the order of the actual sections, and that three of the references are to 17.x while one is to 12.1.  Can we make these a little more symmetric?

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/quicwg/base-drafts/issues/2165