IETF Logo Mail Archive

Re: [xml2rfc] Any recommended way to reference code on github?

Robert Moskowitz <rgm@htt-consult.com> Tue, 14 September 2021 14:08 UTC

Return-Path: <rgm@htt-consult.com>
X-Original-To: xml2rfc@ietfa.amsl.com
Delivered-To: xml2rfc@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 482073A203F for <xml2rfc@ietfa.amsl.com>; Tue, 14 Sep 2021 07:08:17 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.9
X-Spam-Level:
X-Spam-Status: No, score=-1.9 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, NICE_REPLY_A=-0.001, SPF_HELO_NONE=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 Abbu6VUHcvmT for <xml2rfc@ietfa.amsl.com>; Tue, 14 Sep 2021 07:08:15 -0700 (PDT)
Received: from z9m9z.htt-consult.com (z9m9z.htt-consult.com [23.123.122.147]) (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 2AF7B3A203E for <xml2rfc@ietf.org>; Tue, 14 Sep 2021 07:08:15 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by z9m9z.htt-consult.com (Postfix) with ESMTP id 6458F62569; Tue, 14 Sep 2021 10:07:13 -0400 (EDT)
X-Virus-Scanned: amavisd-new at htt-consult.com
Received: from z9m9z.htt-consult.com ([127.0.0.1]) by localhost (z9m9z.htt-consult.com [127.0.0.1]) (amavisd-new, port 10024) with LMTP id 0Bf-y+ugKEYE; Tue, 14 Sep 2021 10:07:10 -0400 (EDT)
Received: from lx140e.htt-consult.com (unknown [192.168.160.29]) (using TLSv1.2 with cipher AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by z9m9z.htt-consult.com (Postfix) with ESMTPSA id 9CA776250B; Tue, 14 Sep 2021 10:07:10 -0400 (EDT)
To: Julian Reschke <julian.reschke@gmx.de>, xml2rfc@ietf.org
References: <462dd2c3-caa4-3fa6-6d60-5bca34d13402@htt-consult.com> <36a74861-0dac-b9bf-8c95-ff1ec83da14c@gmx.de>
From: Robert Moskowitz <rgm@htt-consult.com>
Message-ID: <444489d0-0293-f7b8-5c07-18c9e51db871@htt-consult.com>
Date: Tue, 14 Sep 2021 10:08:09 -0400
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.10.1
MIME-Version: 1.0
In-Reply-To: <36a74861-0dac-b9bf-8c95-ff1ec83da14c@gmx.de>
Content-Type: text/plain; charset="utf-8"; format="flowed"
Content-Transfer-Encoding: 8bit
Content-Language: en-US
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc/hruZLfyMns33_Yh7c-aUg42_akI>
Subject: Re: [xml2rfc] Any recommended way to reference code on github?
X-BeenThere: xml2rfc@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: XML2RFC discussion list <xml2rfc.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml2rfc>, <mailto:xml2rfc-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml2rfc/>
List-Post: <mailto:xml2rfc@ietf.org>
List-Help: <mailto:xml2rfc-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml2rfc>, <mailto:xml2rfc-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 14 Sep 2021 14:08:18 -0000


On 9/14/21 8:41 AM, Julian Reschke wrote:
> Am 14.09.2021 um 14:38 schrieb Robert Moskowitz:
>> I have a script on github,
>>
>> https://github.com/ietf-wg-drip/draft-ietf-drip-rid/blob/master/hhit-gen.py 
>>
>>
>> That I want to reference in a draft.  I don't want to include the
>> script, too big and it will grow still.
>>
>> Is there any common practice for such an informative reference?
>
> This might help:
>
>
> https://datatracker.ietf.org/doc/html/draft-flanagan-7322bis-07#section-4.8.6.9 
>

Thanks Julian.

The example includes a short commit hash.  I see what looks like such a 
hash for my script, c4b7d1b, but it is a link that is a real long 
string.  Do I just include this short string as in the example?

v2.23.0 | Report a Bug | By Email