From e9de976a9478cb68ae2c1bb740c9ba81192ee4a3 Mon Sep 17 00:00:00 2001
From: Sean Whitton <spwhitton@spwhitton.name>
Date: Sat, 5 Aug 2017 10:46:28 -0400
Subject: [PATCH] info on conventions in maintscript flowcharts

---
 policy.xml | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/policy.xml b/policy.xml
index 2ae3691..0b88164 100644
--- a/policy.xml
+++ b/policy.xml
@@ -4570,6 +4570,33 @@ Comment: I stand between the candle and the star.</programlisting>
         prepending or appending package-specific directories.  These
         considerations really apply to all shell scripts.
       </para>
+
+      <section>
+        <title>Note on maintainer script flowcharts</title>
+
+        <para>
+          The flowcharts included in this section use the following conventions:
+        </para>
+
+        <itemizedlist>
+          <listitem>
+            <para>
+              maintainer scripts and their arguments are within boxes;
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              actions carried out external to the scripts are in italics; and
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              the <command>dpkg</command> status of the package at the
+              end of the run are in bold type.
+            </para>
+          </listitem>
+        </itemizedlist>
+      </section>
     </section>
 
     <section id="s-idempotency">
-- 
2.11.4.GIT