Convert away from silly names

[dak.git] / docs / manpages / check-overrides.1.sgml

diff --git a/docs/manpages/check-overrides.1.sgml b/docs/manpages/check-overrides.1.sgml
new file mode 100644 (file)
index 0000000..a4a7c14
--- /dev/null
+++ b/docs/manpages/check-overrides.1.sgml
@@ -0,0 +1,61 @@
+<!-- -*- mode: sgml; mode: fold -*- -->
+<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
+
+<!ENTITY % dakent SYSTEM "dak.ent">
+%dakent;
+
+]>
+
+<refentry>
+  &dak-docinfo;
+
+  <refmeta>
+    <refentrytitle>dak_check-overrides</>
+    <manvolnum>1</>
+  </refmeta>
+
+  <!-- Man page title -->
+  <refnamediv>
+    <refname>dak check-overrides</>
+    <refpurpose>Utility to alter or display the contents of a suite</>
+  </refnamediv>
+
+  <!-- Arguments -->
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>dak check-overrides</>
+      <arg><option><replaceable>options</replaceable></></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <RefSect1><Title>Description</>
+    <para>
+      <command>dak check-overrides</command> is a cruft checker for overrides.
+    </PARA>
+  </REFSECT1>
+
+  <RefSect1><Title>Options</>
+
+    <VariableList>
+      <VarListEntry><term><option>-h/--help</option></>
+       <ListItem>
+         <Para>Show help and then exit.</PARA>
+       </LISTITEM>
+      </VarListEntry>
+
+    </VariableList>
+  </RefSect1>
+
+  <RefSect1><Title>Notes</>
+
+  <Para>dak check-overrides is not a good idea with New Incoming as it doesn't take into account queue/accepted.  You can minimize the impact of this by running it immediately after 'dak process-accepted' but that's still racy because 'dak process-new' doesn't lock with 'dak process-accepted'.  A better long term fix is the evil plan for accepted to be in the DB.</>
+
+  <RefSect1><Title>Diagnostics</>
+    <para>
+      <command>dak check-overrides</command> returns zero on normal operation, non-zero on error.
+    </PARA>
+  </RefSect1>
+
+  &manauthor;
+
+</refentry>