rfc-errata 0.3.0

Build html files from the text RFCs and the errata database.

Automatically apply errata to RFCs

The RFC series is a suite of documents published by the RFC Editor for the benefit of the Internet community. It contains technical and organizational documents about the Internet, including the specifications and policy documents produced by four document streams within the RFC series: the Internet Engineering Task Force (IETF), the Internet Research Task Force (IRTF), the Internet Architecture Board (IAB), and Independent Submissions. Documents in the RFC series are identified by a number and are frozen forever and cannot be changed.

The RFC Editor maintains a database of errata that have been submitted by the consumers of RFCs. These errata, once reported, can be verified, rejected or “held for document update.” The visibility of errata to the consumers of RFCs has historically been poor or nonexistent. This program is part of an effort to raise the visibility of these errata.

This program pulls down a copy of the errata database from the RFC Editor and the text version of an RFC. It then merges the errata and the text of the RFC to produce an HTML file.

Usage

rfc-errata pulls all needed information to run from the RFC Editor website. The tool can be run either to update all RFCs that have errata or only a specific set of RFCs

Basic Usage: rfc-errata [options] [<list of RFCs>]

Options

The following parameters affect how svgcheck behaves, however none are required.

Short	Long	Description
-s	--server=	provide a server to download errata and RFCs from
.	--no-network	do not download errata.json from the website
.	--templates=	directory containing templates to be used
.	--text=	directory to store unmodified text RFCs in
.	--html=	directory to place modified HTML RFCs in
.	--css=	relative location for CSS files at final website
.	--all	update all RFCs rather than a list of RFCs
.	--reported=	apply ‘reported’ errata (yes/no)
.	--held=	apply ‘held for update’ errata (yes/no)
.	--rejected=	apply ‘rejected’ errata (yes/no)
.	--verified=	apply ‘verified’ errata (yes/no)
.	--force	rebuild all HTML files rather than using timestamps
.	--nocopy	clear destination copy list
.	--path	path to css files in the HTML output
.	--copyto	specify the destinations to copy to (multiple)
-v	--verbose	print extra information
-V	--version	display the version number and exit

Operations

The tool can be used in a batch mode which is designed to be used in a cron job. For this purpose, only the documents which have new errata will be regenerated and published to the necessary locations. Documents for which errata are removed will not be regenerated as there is no notification to that fact.

The tool stores information in the file status.json in the CWD. This file is used to remember command line options between different invocations of the tool. This means that, for example, the set of errata to be applied is remembered between invocations and does not need to be specified every time. The tool also stores the file errata.json in the CWD.

When failures occur during processing, they are logged into the file “errors.log” in the CWD.

The default values for options are:

• server = www.rfc-editor.org

• templates from the installation directory of rfc-errata

• html = ./html

• text = ./rfc

• css = ./css

• reported = no

• rejected = no

• held = yes

• verified = yes

Dependencies

None

Changelog

Version 0.3.0 (Sun 02 Nov)

• Modify the doc-id field so that it is lower-case and does not have leading zeros

Version 0.2.1 (Tue 06 August)

• Update the header template to say this is not an offical RFC

Version 0.2.0 (Mon 22 July)

• Fixed an error when specifying the html directory.