Re: [xml2rfc] XInclude should be used instead of PI include

Kesara Rathnayake <kesara@staff.ietf.org> Wed, 28 June 2023 00:22 UTC

Return-Path: <kesara@staff.ietf.org>
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 282F3C151701 for <xml2rfc@ietfa.amsl.com>; Tue, 27 Jun 2023 17:22:45 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.896
X-Spam-Level:
X-Spam-Status: No, score=-1.896 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, 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.20221208.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 FtC6gwMh3YLy for <xml2rfc@ietfa.amsl.com>; Tue, 27 Jun 2023 17:22:41 -0700 (PDT)
Received: from mail-ej1-x62c.google.com (mail-ej1-x62c.google.com [IPv6:2a00:1450:4864:20::62c]) (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 6FF34C151543 for <xml2rfc@ietf.org>; Tue, 27 Jun 2023 17:22:41 -0700 (PDT)
Received: by mail-ej1-x62c.google.com with SMTP id a640c23a62f3a-991aac97802so410174366b.1 for <xml2rfc@ietf.org>; Tue, 27 Jun 2023 17:22:41 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=staff-ietf-org.20221208.gappssmtp.com; s=20221208; t=1687911759; x=1690503759; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=tUZRjguevBKGhT7nzZWNh2DdB6S8D+5QlH4wp/tVrGo=; b=2YmZaQWc4QZoJJ5hRibCcahfqjR8xI7oJrRyyvZvZ/+fpLpsnVL/Qv13NtNPwymq2r uIsjRAiwshXSp75s1+F1hPi99xvIgloK/p0x6tI1R0sfW+qzWI4FTbu7ExxDM3NQC/hk CSBmsaTf+vCrhyfOyRrBOQCJruR9E5pOmhhMACDAbbrIAJ+F9QIhmeo6rg9KBsJR9L6M OrowoiFqLuIQ39jxEUxzvckBFVOmGk83ij/2QXPA1ce1RfgN/HKd1Esm8a3HNnjuM8Oe OqRXk9cR0cAk40dkx1lMnNdtLDqukEpMnwLsgPW4yyIH5lvB/++9SZowIIj9AG/SVeTr n84g==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1687911759; x=1690503759; h=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=tUZRjguevBKGhT7nzZWNh2DdB6S8D+5QlH4wp/tVrGo=; b=aIoGE7uxGnk2JnBEU47NZo+EBPrb+JRQmcWoKycHQ+99/BxlvxwR9fHk9BCvRVMy19 CFVtk3OoKewzvPWbYZVutmYw/hJDsc6VKRItiMYFDly3tqLgVtkOhKztxzE6WNkMNr69 XqfdPraNQBhdrm4Y6OGY/w4wqAhhvJX4W/Tu8hvoI55vcDn5gLy7J+6yBXUrOSlJzXmT 6v7w+l6suJ665KGaVOpwKigepVlPMxzQBnK02b4B0Wf7KzsQAaOdqOkQ0/Rf8l+Cq5bD oi7iCskc5uHTWFCcrrGroVBboezQYsk+vhCA/Ax8n/T0b5xA9M9q/kwvuJ24kyMGf0rg zz3w==
X-Gm-Message-State: AC+VfDwDiG+BGIz3t29iqpGzMsP24QM0wFOQ4xdEyvSzV3Gtjs2mkqHg 2GCWB3lR6kAb30FJl3aVPglA68vdBZwExbRawnXS0t9W7aQIZ2sxVrzLJg==
X-Google-Smtp-Source: ACHHUZ7EaTy6CyO/XawYDoiGKhEHSxAddLVYKUPHbBm0XHdX2wAGmU/fcHScE6gXphDT2nsBX37khkON6jwdD+Pg82o=
X-Received: by 2002:a17:906:3104:b0:992:78fd:f6c3 with SMTP id 4-20020a170906310400b0099278fdf6c3mr49942ejx.4.1687911758792; Tue, 27 Jun 2023 17:22:38 -0700 (PDT)
MIME-Version: 1.0
References: <m2v8f9ua1d.wl-randy@psg.com> <1C2D7469-A3FE-4029-9F5F-649E2AC3B390@nostrum.com> <m2ttutu5b9.wl-randy@psg.com> <CAD2=Z86oWFs6yPm6Fzt1S4HbFJnP8t=qE58c8NnFo-L=UouRiw@mail.gmail.com> <m2o7l1u11k.wl-randy@psg.com> <CAD2=Z86Nr1KnpPQNNu55kL75i5D9CaHXa0WDngkKxBJMLeHU+A@mail.gmail.com> <m2mt0ltn0h.wl-randy@psg.com>
In-Reply-To: <m2mt0ltn0h.wl-randy@psg.com>
From: Kesara Rathnayake <kesara@staff.ietf.org>
Date: Wed, 28 Jun 2023 12:22:27 +1200
Message-ID: <CAD2=Z85ujG_JKK=FntZtOxgq8sA-AEQ3nKQ0qfF-N55WNVwZyQ@mail.gmail.com>
To: Randy Bush <randy@psg.com>
Cc: Robert Sparks <rjsparks@nostrum.com>, xml2rfc@ietf.org
Content-Type: text/plain; charset="UTF-8"
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml2rfc/z5cPyDcGXY23rjO2TAh6Q6-XXnY>
Subject: Re: [xml2rfc] XInclude should be used instead of PI include
X-BeenThere: xml2rfc@ietf.org
X-Mailman-Version: 2.1.39
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: Wed, 28 Jun 2023 00:22:45 -0000

Hi Randy,

Looks like the `XML_LIBRARY` environment variable is an undocumented
feature in xml2rfc.
Unfortunately, this works only if the BibXML reference is not an
absolute path or URL.
When the reference is an URL, xml2rfc checks the cache directory first
and if it misses the cache, makes a network request.

Cheers,
Kesara

On Tue, 27 Jun 2023 at 18:52, Randy Bush <randy@psg.com> wrote:
>
> > That document needs some improvement.
> >
> > You can provide a cache directory with `--cache, -c = PATH `
> > See https://ietf-tools.github.io/xml2rfc/#appendix-B.5-1.4.1
> > And use `--no-network, -N` to avoid network resolvers.
> > See https://ietf-tools.github.io/xml2rfc/#appendix-B.4-1.6.1
>
> thanks, i think.  will try to get time to trudge through this tomorrow
>
> > After setting up your rsync data directories, how do you run xml2rfc?
> > What configuration options do you use?
>
>     $ grep -i xml .bashrc
>     export XML_LIBRARY=.:/Users/randy/refs/rfc:/Users/randy/refs/id
>
> and the Makefile has
>
>     xml2rfc $(NAME).xml --html --text
>
> randy



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