Re: [Teas] inclusion of references in protocol feature configuration configuration

"Adrian Farrel" <adrian@olddog.co.uk> Mon, 13 November 2017 10:42 UTC

Return-Path: <adrian@olddog.co.uk>
X-Original-To: teas@ietfa.amsl.com
Delivered-To: teas@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id CA7C5124BE8; Mon, 13 Nov 2017 02:42:19 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.619
X-Spam-Level:
X-Spam-Status: No, score=-2.619 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-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 bzr8PNVau138; Mon, 13 Nov 2017 02:42:18 -0800 (PST)
Received: from asmtp4.iomartmail.com (asmtp4.iomartmail.com [62.128.201.175]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id EC40D120726; Mon, 13 Nov 2017 02:42:17 -0800 (PST)
Received: from asmtp4.iomartmail.com (localhost.localdomain [127.0.0.1]) by asmtp4.iomartmail.com (8.13.8/8.13.8) with ESMTP id vADAgEYo009615; Mon, 13 Nov 2017 10:42:14 GMT
Received: from 950129200 (dhcp-8924.meeting.ietf.org [31.133.137.36]) (authenticated bits=0) by asmtp4.iomartmail.com (8.13.8/8.13.8) with ESMTP id vADAg8l0009484 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Mon, 13 Nov 2017 10:42:12 GMT
Reply-To: adrian@olddog.co.uk
From: Adrian Farrel <adrian@olddog.co.uk>
To: 'Lou Berger' <lberger@labn.net>, draft-ietf-teas-yang-rsvp-te@ietf.org, draft-ietf-teas-yang-rsvp@ietf.org, draft-ietf-teas-yang-te@ietf.org
Cc: teas@ietf.org
References: <150932270746.3426.3220773532456344196@ietfa.amsl.com> <8de1c9eb-133a-14ea-f323-ef5502a12f07@labn.net>
In-Reply-To: <8de1c9eb-133a-14ea-f323-ef5502a12f07@labn.net>
Date: Mon, 13 Nov 2017 10:42:04 -0000
Message-ID: <0c0a01d35c6c$110c52c0$3324f840$@olddog.co.uk>
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
X-Mailer: Microsoft Outlook 14.0
Thread-Index: AQKqlwxX7koj/XpId9+jof11b8xvzgLGsn2+oU1ybQA=
Content-Language: en-gb
X-TM-AS-MML: disable
X-TM-AS-Product-Ver: IMSS-7.1.0.1679-8.1.0.1062-23462.006
X-TM-AS-Result: No--15.765-10.0-31-10
X-imss-scan-details: No--15.765-10.0-31-10
X-TMASE-MatchedRID: VfovoVrt/oYTRq2fvEtvbYzb2GR6Ttd3kUtSee+57IHczkKO5k4APmdR 3KZbtfZIZk3ki93OpLD22u4R8W4u+z4gGkEowIKZBEfU2vugRF0ZYA38gj3BxOJsgXmCsctFqvW iXskWA6b6HhZWpEMzZPFPDHhQkgxyCFc8edUb9x5DP8uRDLPyZhmyTBaqiJvcMiCpq6n6ariFQW TLaCVa4/rGMiCsF6vWEt10QoXBwhKD5Bu9Z++7yOYAh37ZsBDCkk5xcxBziMER34ro7k23nfNvm SaCnjTlt+odoSua73aRk6XtYogiarQ/aqQZTRfKVnRXm1iHN1bEQdG7H66TyH4gKq42LRYkTK/a 3OcilnYwkJK5m0Gzj+a6ywX0pYDygms6CmtQoIx+3BndfXUhXQ==
Archived-At: <https://mailarchive.ietf.org/arch/msg/teas/PUQStXsKO8fpuxyCMQsC3RF0ICk>
Subject: Re: [Teas] inclusion of references in protocol feature configuration configuration
X-BeenThere: teas@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: Traffic Engineering Architecture and Signaling working group discussion list <teas.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/teas>, <mailto:teas-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/teas/>
List-Post: <mailto:teas@ietf.org>
List-Help: <mailto:teas-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/teas>, <mailto:teas-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 13 Nov 2017 10:42:20 -0000

FWIW, this used to show up as an issue in MIB modules as well. A Description
clause or a Reference clause would mention another document (such as an RFC) but
would not include it as a square bracket reference (because, importantly, the
module may be extracted as a standalone thing and so can't have a citation style
reference). That meant that some documents that are important are not properly
referenced.

The way we solved this in MIB modules was to include a short note in the text
immediately before the module saying "The module that follows makes reference to
the following documents: [ref1], [ref2], ..."

Adrian

> -----Original Message-----
> From: Teas [mailto:teas-bounces@ietf.org] On Behalf Of Lou Berger
> Sent: 10 November 2017 15:29
> To: draft-ietf-teas-yang-rsvp-te@ietf.org; draft-ietf-teas-yang-rsvp@ietf.org;
> draft-ietf-teas-yang-te@ietf.org
> Cc: teas@ietf.org
> Subject: [Teas] inclusion of references in protocol feature configuration
> configuration
> 
> Hi,
> 	In reviewing the the yang-te, rsvp and rsvp=te modules I noticed that
> references aren't included in most config groupings/nodes.  Given the
> number of RFCs used to define the mechanisms covered by these modules I
> think it's important to include a reference to the RFC that defines the
> feature/information element covered in the model. I suspect this
> comments is also applicable to other modules.
> 
> Thanks,
> Lou
> 
> _______________________________________________
> Teas mailing list
> Teas@ietf.org
> https://www.ietf.org/mailman/listinfo/teas