Document the Dgit field for Debian Source Control files.

[debian/debian-policy.git] / policy.sgml

diff --git a/policy.sgml b/policy.sgml
index cb1093fed776e0b89b0800b2ce793c00bdf41ed9..27082429c81303e3bdc0c51c2ac2c38e2892eff1 100644 (file)
--- a/policy.sgml
+++ b/policy.sgml
@@ -2759,6 +2759,7 @@ Package: libc6
          <item><qref id="f-Uploaders"><tt>Uploaders</tt></qref></item>
          <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
          <item><qref id="f-VCS-fields"><tt>Vcs-Browser</tt>, <tt>Vcs-Git</tt>, et al.</qref></item>
+         <item><qref id="f-Dgit"><tt>Dgit</tt></qref></item>
          <item><qref id="f-Standards-Version"><tt>Standards-Version</tt></qref> (recommended)</item>
          <item><qref id="sourcebinarydeps"><tt>Build-Depends</tt> et al</qref></item>
          <item><qref id="f-Package-List"><tt>Package-List</tt></qref> (recommended)</item>
@@ -3840,6 +3841,26 @@ Checksums-Sha256:
            this value is assumed for paragraphs lacking this field.
          </p>
        </sect1>
+
+       <sect1 id="f-Dgit">
+         <heading><tt>Dgit</tt></heading>
+
+         <p>
+           Folded field containing a single git commit hash, presented in
+           full, followed optionally by whitespace and other data to be
+           defined in future extensions.
+         </p>
+
+         <p>
+           Declares that the source package corresponds exactly to a
+           referenced commit in a Git repository available at the canonical
+           location called <em>dgit-repos</em>, used by <prgn>dgit</prgn>, a
+           bidirectional gateway between the Debian archive and Git.  The
+           commit is reachable from at least one reference whose name matches
+           <tt>refs/dgit/*</tt>.  See the manual page of <prgn>dgit</prgn> for
+           further details.
+         </p>
+       </sect1>
       </sect>
 
       <sect>
@@ -9473,6 +9494,23 @@ done
          </p>
        </sect1>
       </sect>
+
+      <sect id="filenames">
+       <heading>File names</heading>
+
+        <p>
+         The name of the files installed by binary packages in the system PATH
+         (namely <tt>/bin</tt>, <tt>/sbin</tt>, <tt>/usr/bin</tt>,
+         <tt>/usr/sbin</tt> and <tt>/usr/games</tt>) must be encoded in
+         ASCII.
+       </p>
+
+       <p>
+         The name of the files and directories installed by binary packages
+         outside the system PATH must be encoded in UTF-8 and should be
+         restricted to ASCII when it is possible to do so.
+       </p>
+      </sect>
     </chapt>