Pre-PDP discussion: "All PDP emails, documents and websites should come with unified diff"
Dear all, this is the third suggestion: All PDP-related emails, web pages, and other documents by RIPE will either carry a unified diff (diff -ruN) or directly link to a page which shows said unified diff. Other formats, like full text, old/new text, etc are encouraged as well, but the diff is the binding format in which PDPs are published, documented, and discussed. Rationale: It's needlessly hard to read and compare full or partial text dumps, forcing people to do work by themselves and for themselves which a computer could do once and for all. A XML-based format that's parse-able by new tools has been proposed as an alternative. This would mean extra work while defining the XML format, to write new tools, and cut of the extensive tools and workflows around unified diffs. The point has also been raised that word diffs may be easier to read. Quoth the manpage: Nevermerge! Show words as [-removed-] and {+added+}. Makes no attempts to escape the delimiters if they appear in the input, so the output may be ambiguous. Ironically, --word-diff in git comes with an option that allows parsing, --porcelain, which turns word-based diff back into line-based diffs: Use a special line-based format intended for script consumption. Added/removed/unchanged runs are printed in the usual unified diff format, starting with a +/-/` ` character at the beginning of the line and extending to the end of the line. Newlines in the input are represented by a tilde ~ on a line of its own. Long story short: Unified diffs are called unified diffs and universally accepted for a reason. Richard
Dear all, this is the updated version of my third suggestion: All PDP-related emails, web pages, and other documents published by RIPE NCC will either carry a unified diff (diff -ruN) or directly link to a page which shows said unified diff. Other formats, like full text, old/new text, etc are encouraged as well, but the diff is the binding format in which PDPs are published, documented, and discussed. Other than "published by RIPE NCC", there is no change. And, in the spirit of this proposal, see [1]. Richard [1] http://paste.debian.net/plain/245813
* Richard Hartmann
All PDP-related emails, web pages, and other documents published by RIPE NCC will either carry a unified diff (diff -ruN) or directly link to a page which shows said unified diff.
Other formats, like full text, old/new text, etc are encouraged as well, but the diff is the binding format in which PDPs are published, documented, and discussed.
As discussed on IRC, during the preparation of 2013-03 I submitted a last-minute amendment. This amendment made it into the complete new policy document[1], but not in the side-by-side diff[2]. [1] http://www.ripe.net/ripe/docs/other-documents/ipv4-address-allocation-and-as... [2] http://www.ripe.net/ripe/docs/other-documents/ipv4-address-allocation-and-as... I noticed this myself, and it was corrected shortly after. This is not a complaint - I have only myself to blame for changing the proposal after all the documentation had been produced. That said, if both the current and the new proposed policy was written in a standardised plain-text[ish] format, creating the side-by-side diff page could have been a fully automated task with no risk of omissions, rather than a manual one. Just a data point... Tore
participants (2)
-
Richard Hartmann
-
Tore Anderson