Package: debian-policy Severity: minor Control: tags -1 + patch The description of control file syntax in §5.1 references numerous characters, some by number and some as simple display of the character, and some as informal names. Some of these mentions are confusing. The section also specifies that all control files are encoded as UTF-8, so knowledge of Unicode is (IMO correctly) assumed of the reader. This patch standardises the mention of characters in §5.1 to explicitly give Unicode code point references and (where appropriate) the literal character unambiguously quoted. -- \ “Pinky, are you pondering what I'm pondering?” “Wuh, I think | `\ so, Brain, but will they let the Cranberry Duchess stay in the | _o__) Lincoln Bedroom?” —_Pinky and The Brain_ | Ben Finney <ben@benfinney.id.au>
From 04bffa59187df69969d9736dc865514fcd30b840 Mon Sep 17 00:00:00 2001 From: Ben Finney <ben@benfinney.id.au> Date: Mon, 18 Apr 2016 13:31:14 +1000 Subject: [PATCH 1/2] Clarify which characters constitute syntax of control files. --- policy.sgml | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/policy.sgml b/policy.sgml index 404dc737..236bf743 100644 --- a/policy.sgml +++ b/policy.sgml @@ -2541,13 +2541,16 @@ endif </p> <p> - Each paragraph consists of a series of data fields. Each field - consists of the field name followed by a colon and then the - data/value associated with that field. The field name is - composed of US-ASCII characters excluding control characters, - space, and colon (i.e., characters in the ranges 33-57 and - 59-126, inclusive). Field names must not begin with the comment - character, <tt>#</tt>, nor with the hyphen character, <tt>-</tt>. + Each paragraph consists of a series of data fields. Each + field consists of the field name followed by a colon and + then the data/value associated with that field. The field + name is composed of US-ASCII characters excluding control + characters, space, and colon (i.e., characters in the ranges + U+0021 “<tt>!</tt>” through U+0039 “<tt>9</tt>”, and U+003B + “<tt>;</tt>” through U+007E “<tt>~</tt>”, inclusive). Field + names must not begin with the comment character (U+0023 + “<tt>#</tt>”), nor with the hyphen character (U+002D + “<tt>-</tt>”). </p> <p> @@ -2624,17 +2627,20 @@ Package: libc6 </p> <p> - Paragraph separators (empty lines) and lines consisting only of - spaces and tabs are not allowed within field values or between - fields. Empty lines in field values are usually escaped by - representing them by a space followed by a dot. + Paragraph separators (empty lines), and lines consisting + only of U+0020 SPACE and U+0009 TAB, are not allowed within + field values or between fields. Empty lines in field values + are usually escaped by representing them by a U+0020 SPACE + followed by a U+002E “<tt>.</tt>”. </p> <p> - Lines starting with # without any preceding whitespace are comments - lines that are only permitted in source package control files - (<file>debian/control</file>). These comment lines are ignored, even - between two continuation lines. They do not end logical lines. + Lines starting with U+0023 “<tt>#</tt>”, without any + preceding whitespace, are comment lines that are only + permitted in source package control files + (<file>debian/control</file>). These comment lines are + ignored, even between two continuation lines. They do not + end logical lines. </p> <p> -- 2.8.0.rc3
Attachment:
signature.asc
Description: PGP signature