Re: [Rfc-markdown] kramdown-rfc-extract-sourcecode: Provide better names to the extracted files

Kesara Rathnayake <kesara@staff.ietf.org> Wed, 27 September 2023 09:40 UTC

Return-Path: <kesara@staff.ietf.org>
X-Original-To: rfc-markdown@ietfa.amsl.com
Delivered-To: rfc-markdown@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 3A8B8C151534 for <rfc-markdown@ietfa.amsl.com>; Wed, 27 Sep 2023 02:40:21 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.906
X-Spam-Level:
X-Spam-Status: No, score=-1.906 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_BLOCKED=0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=staff-ietf-org.20230601.gappssmtp.com
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id jTuGRtA-oyEe for <rfc-markdown@ietfa.amsl.com>; Wed, 27 Sep 2023 02:40:20 -0700 (PDT)
Received: from mail-ed1-x52a.google.com (mail-ed1-x52a.google.com [IPv6:2a00:1450:4864:20::52a]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 9A3E7C151531 for <rfc-markdown@ietf.org>; Wed, 27 Sep 2023 02:40:20 -0700 (PDT)
Received: by mail-ed1-x52a.google.com with SMTP id 4fb4d7f45d1cf-533cbbd0153so9250452a12.0 for <rfc-markdown@ietf.org>; Wed, 27 Sep 2023 02:40:20 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=staff-ietf-org.20230601.gappssmtp.com; s=20230601; t=1695807618; x=1696412418; darn=ietf.org; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=qQN3A3SxpetNXrNlZ8cKINsAj77fo2rm1QW2FSKp7to=; b=VWAkOO2mTk+NfwJbLc6gUAJfO4iylXIvRmdT9pt1hohuFEI12UOBxMVgjEX3P74U1g EwU8AU/PKqA3y1pcHer8HTRuhqvjXsNu/lw2ZppHozyY4VEiLrGcxCSfPI2gO4egKmSP /j1nvLODNEldASF6xGPKw5Q3uBA3HLPPfxYfL3faSsjLxLFzqbpT7NJcg8sZ8DsoEMOK AUue7z9QoJsY3Oqjvo/NcGhgvVOcSEIgalAiRGWAAUyzCxHdmv4WpTjrD2uSKyNCyiRO NjQYBJGBxvEUGW0Wu8wh0pC2cjZ9KpOf4khPQpw6X7bPqU4ekybbDFfL2SX+AqxnRUHw KTHQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1695807618; x=1696412418; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=qQN3A3SxpetNXrNlZ8cKINsAj77fo2rm1QW2FSKp7to=; b=Vx7xaZ3QEZny7/ZcPFOzwrdvp0yjwgxldEK0dUXW8olzIk4H3lhxusIEO8571Yyt30 vlwNx3qU7KYM87u6nMaIjLSk3pUkaQzT80lOUbtg+phhin8VcKZHeXFgK8UAvd+BMVS6 k064FzLhmYHLpfnNhUn7mxZgzk3ixhYE1eGQ/OqbD+U9c5L2qAidwl0Z5qyGGRomd116 IQWdw8xjs1AAMqb+C+No6+XjZLwtZ4Kebk+NvRQgTHYRKniW3HTH8De39PuoJkUAGevK WtonW/KwQUYF4jk54L+7FEHcNLxpKBAafHCLm+RdsOxnHeKxskIxnifITVOSh3+NOFE2 zP3A==
X-Gm-Message-State: AOJu0YyEmdF0+3qhxBeOc2C7arJBAOEAoKrOHc5JADoat+NlDT6u0ql2 DI6/klwfIDjy8oS8iqpEhnXzQVtEbulWhjlo7N9Fa80jngXlY0OutEGu0A==
X-Google-Smtp-Source: AGHT+IFnxAPpwXpxPNfg4UJPGdzLdozoflPbJyyNBMbLl0lkTCp6H6LfLvmlKQ66nsVL7fIgEvu/X2NnMGYFdXiBbXU=
X-Received: by 2002:a17:906:8a4d:b0:9ae:614f:2023 with SMTP id gx13-20020a1709068a4d00b009ae614f2023mr1135381ejc.56.1695807618686; Wed, 27 Sep 2023 02:40:18 -0700 (PDT)
MIME-Version: 1.0
References: <70B4AB74-4BC7-476A-B88A-B7A5DE5AADBD@tzi.org>
In-Reply-To: <70B4AB74-4BC7-476A-B88A-B7A5DE5AADBD@tzi.org>
From: Kesara Rathnayake <kesara@staff.ietf.org>
Date: Wed, 27 Sep 2023 22:40:07 +1300
Message-ID: <CAD2=Z87d5WZvpZBesspbvqZ4YQD2tsag6E4qC0M5w49T3QqULA@mail.gmail.com>
To: Carsten Bormann <cabo@tzi.org>
Cc: rfc-markdown@ietf.org
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/QjsjzEZpZaF6rVTfx7YXWwYYh84>
Subject: Re: [Rfc-markdown] kramdown-rfc-extract-sourcecode: Provide better names to the extracted files
X-BeenThere: rfc-markdown@ietf.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: "rfc-markdown is a discussion list for people writing I-Ds and RFCs in Markdown and the authors of the tools used for that." <rfc-markdown.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/rfc-markdown/>
List-Post: <mailto:rfc-markdown@ietf.org>
List-Help: <mailto:rfc-markdown-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 27 Sep 2023 09:40:21 -0000

> But, as mentioned in the PR, it means there will be a flag day (probably in 1.6.44):

May be time to bump up to 1.7.0 with the breaking changes?
  --Kesara

On Tue, 26 Sept 2023 at 04:12, Carsten Bormann <cabo@tzi.org> wrote:
>
> PR #208 [1] proposes to improve the way kramdown-rfc-extract-sourcecode generates the filenames for sourcecode extracted by it:
>
> > * sourcecode-name values are less heavily mangled; the characters "-" and "." are now allowed (except at the start) and no longer converted into underscores.
> >
> > * unnamed files now have their sourcecode type attached (e.g., if the sourcecode type is abnf, unnamed-123 ➔ unnamed-123.abnf)
> >
> > This update will, unfortunately, be a flag day for those using this feature from Makefiles or includes in the markdown.
> >
> > close #206
>
> I believe this will be a net win for most applications.
>
> But, as mentioned in the PR, it means there will be a flag day (probably in 1.6.44):
> E.g., in draft-ietf-jsonpath-base.md, we’ll have to change:
>
> OLD: {::include sourcecode/abnf/jsonpath_collected_abnf}
> NEW: {::include sourcecode/abnf/jsonpath-collected.abnf}
>
> I apologize for this nuisance; we normally don’t do flag day changes, but it seems expedient to not introduce tedious gating mechanisms for this specific change in a quite young tool.
>
> If you are using kramdown-rfc-extract-sourcecode today and see a problem with this flag day change (or any other problem, of course), please comment to the PR [1].
>
> Grüße, Carsten
>
> [1]: https://github.com/cabo/kramdown-rfc/pull/208
>
> _______________________________________________
> Rfc-markdown mailing list
> Rfc-markdown@ietf.org
> https://www.ietf.org/mailman/listinfo/rfc-markdown



-- 
Kesara Rathnayake
Senior Software Development Engineer - IETF Administration LLC
kesara@staff.ietf.org