Re: [Rfc-markdown] [xml2rfc-dev] [xml2rfc] End of support for xml2rfc on Python 2.x is coming soon

Job Snijders <job@instituut.net> Wed, 09 October 2019 00:00 UTC

Return-Path: <job@instituut.net>
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 921BD1200FE for <rfc-markdown@ietfa.amsl.com>; Tue, 8 Oct 2019 17:00:23 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.897
X-Spam-Level:
X-Spam-Status: No, score=-1.897 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_NONE=0.001, URIBL_BLOCKED=0.001] autolearn=unavailable autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=instituut-net.20150623.gappssmtp.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 Jy4QpdjibLs6 for <rfc-markdown@ietfa.amsl.com>; Tue, 8 Oct 2019 17:00:20 -0700 (PDT)
Received: from mail-ot1-x343.google.com (mail-ot1-x343.google.com [IPv6:2607:f8b0:4864:20::343]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 460AB1200B3 for <rfc-markdown@ietf.org>; Tue, 8 Oct 2019 17:00:20 -0700 (PDT)
Received: by mail-ot1-x343.google.com with SMTP id m19so173609otp.1 for <rfc-markdown@ietf.org>; Tue, 08 Oct 2019 17:00:20 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=instituut-net.20150623.gappssmtp.com; s=20150623; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc:content-transfer-encoding; bh=EPJeALIFxIu0XyXuSx4aLAk+QCKCgRINX3FRaaHRA0c=; b=bsbFjRomQzpgWKQLFiSdg1jeybE2nvU48I0rJ1rH1JZWGvaUfVsCUfcquTqyxNSaDZ WZQCw/3Wb7STtVb28ybpXm5n98CV9f1IffN9NXLcik4TCWMVQvINn2pma4M7MKsWRFC/ 9v+DSLa1L5qaNgozI/kbznYnKmlmY0rnwK+ZFxPcNlFWLsoIYzkZLfyrATpEHajFYNs5 IbXBy5aym6TNYc0HAY1Bb3bEsW7ErAzYMM0zOA+fkFQyuVxzfLiX3UwaL32LptxWqVYS Hb8CCHJCXoSZomSmveWZu2KHTEJ+hCpf6vaYMifKEv1izgSmcrya0IaQRIJ7oGo6w+tt +jQQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc:content-transfer-encoding; bh=EPJeALIFxIu0XyXuSx4aLAk+QCKCgRINX3FRaaHRA0c=; b=oKmDwaPl7PK/QApaS7Pfx2FowGrJOWqFunvDX/9YcPEVhpybBogYytX9ihmaMpvAvB uK/GNru1vPVZ8Nwz0l8/lKPT6L8xvlnjj0v2m+DDLpLBQZQL23EdqTHybJaRYa467fRk W6GkiffEFJlTXa4vaNYfOnYGbkQydFU9U2ybfbS8IqgiTzXhqphWhs6XzVZL6agddEJK 03pQgZJoAjZ6tlqtv4Qy/p/k0c3HYGqBum7VhAUTBk43xqQt4rRO/eVlyov75zr3Ueem xv2cgb9FtVowdUHcb3dfiYaL5Kv+bobwxbQMhG5+EYEQXilcHx0E7qnVq00+Icj1DUMe qCSg==
X-Gm-Message-State: APjAAAVGxv7dQ+4iAENLF79mCBKcO0q8AwEaCMi4yPJvUg+6LN+7Karq O2vxUDVxzTR3Eh2OkEIDgiZxgfD/Kvee1egPoDg6rQ==
X-Google-Smtp-Source: APXvYqx/U63Wn0NmONxZ5oXCNH/inzdj2eg5oZLtvnF4ijBCC5A7ffm7/SlW2/z5NUAVyOXvMa+sfDCYxqk6nwSM5+Y=
X-Received: by 2002:a05:6830:150c:: with SMTP id k12mr685327otp.106.1570579218857; Tue, 08 Oct 2019 17:00:18 -0700 (PDT)
MIME-Version: 1.0
References: <082EE9F1-D4AA-487F-BB8C-08CDB59C5A2F@vigilsec.com> <858628DA-84DA-4982-89D7-D652E04ACA10@gmail.com> <da8ffcbf-33dd-6fe9-e251-0e3de47c611f@levkowetz.com>
In-Reply-To: <da8ffcbf-33dd-6fe9-e251-0e3de47c611f@levkowetz.com>
From: Job Snijders <job@instituut.net>
Date: Wed, 9 Oct 2019 00:00:06 +0000
Message-ID: <CACWOCC-uuYGz54dExA5CwftowbpcBq4kQHJwCBWHNC1za_q70w@mail.gmail.com>
To: Henrik Levkowetz <henrik@levkowetz.com>
Cc: Fred Baker <fredbaker.ietf@gmail.com>, Tools Team Discussion <tools-discuss@ietf.org>, rfc-markdown@ietf.org, xml2rfc@ietf.org, xml2rfc-dev@ietf.org, IETF <ietf@ietf.org>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/yR6wQnpTP_clN0HqxXzLjxTZpUM>
Subject: Re: [Rfc-markdown] [xml2rfc-dev] [xml2rfc] End of support for xml2rfc on Python 2.x is coming soon
X-BeenThere: rfc-markdown@ietf.org
X-Mailman-Version: 2.1.29
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, 09 Oct 2019 00:00:24 -0000

On Tue, Oct 8, 2019 at 10:23 PM Henrik Levkowetz <henrik@levkowetz.com>; wrote:
> On 2019-10-08 23:47, Fred Baker wrote:
> > That all fine, and as predictable as you say. What would very helpful
> > would be a road map: if you’re using {windows X|Mac X|Linux
> > X|whatever}, we think you should look at tools {D,E,F}.
> >
> > Speaking personally, I am on a Mac and using XMLmind with Fenner’s
> > tools. They mostly worked (note the past tense) except when they
> > didn’t. Telling me “well, ABCDEF supports <IETF tools du jour if you
> > can read Sanskrit>“ doesn’t quite work.
> >
> > I used to write in NROFF. I’ll do what it takes. But really?
>
> I'm sorry if the text wasn't clear enough.  The roadmap is this:  Please
> install Python 3.5 or higher on your system, and install coming versions
> of xml2rfc using the 'pip3' command which is part of that Python install.
>
> When we got to the xml2rfc 3.0.0 release, I had planned to update the
> release note with the information about using pip3, but I'm perfectly
> happy saying it now, too.
>
> Of course, if your default python is Python 3.5 or higher already, then
> using plain 'pip' to install will continue to work.

We should note that the potential for pip/pip3 confusion is a result
of how the python community approached this transition (acknowleding
what their options were in context of how the packaging eco system was
set up). Not ideal, but it is what it is.

I think it would be good to update public facing documentation about
xml2rfc that pip3 must be used, to make it very clear that any version
of xml2rfc is not expected to work correctly on python2 systems.

Perhaps the final update to xml2rfc 2.x series should be to add a
check at boot whether the python interpreter's major version is lower
than 3, and if so, exit the xml2rfc program with an informative
message and a non-zero exit code, inform the user that python3 must be
used? Sometimes it is better to just break fast & early.

Between the name of the tool (note the 2 in "xlm2rfc"), the industry's
transition from python 2 to python 3, and IETF's transition from the
v2 to the v3 RFC XML format, it is no surprise to me end users easily
become confused. A simple strong message that python2 can't be used
might be helpful, even if it appears somewhat unforgiving.

Kind regards,

Job