r9973 - packages/doom-packaging

[Jon Dowland]

Author: jmtd
Date: 2009-07-05 22:31:40 +0000 (Sun, 05 Jul 2009)
New Revision: 9973

Modified:
   packages/doom-packaging/Makefile
   packages/doom-packaging/policy.sgml
   packages/doom-packaging/version.ent
Log:
update w/ no-iwad-alternative proposal

Modified: packages/doom-packaging/Makefile
===================================================================
--- packages/doom-packaging/Makefile	2009-07-05 22:20:12 UTC (rev 9972)
+++ packages/doom-packaging/Makefile	2009-07-05 22:31:40 UTC (rev 9973)
@@ -2,7 +2,7 @@
 
 policy.html: policy.html/index.html
 
-policy.html/index.html: policy.sgml
+policy.html/index.html: policy.sgml version.ent
 	debiandoc2html $(HTMLARGS) policy.sgml
 	tidy -m -q -asxhtml policy.html/*html || [ $$? -eq 1 ]
 

Modified: packages/doom-packaging/policy.sgml
===================================================================
--- packages/doom-packaging/policy.sgml	2009-07-05 22:20:12 UTC (rev 9972)
+++ packages/doom-packaging/policy.sgml	2009-07-05 22:31:40 UTC (rev 9973)
@@ -126,11 +126,40 @@
           <p>
             
             The debian menu heirarchy for all Doom packages should be
-            <tt>Games/Action</tt>. <!-- TODO: revise once
-            Bill's menu proposals are accepted -->
+            <tt>Games/Action</tt>.
 
           </p>
         </sect>
+        <sect><heading>.desktop files</heading>
+          <p>
+
+            A complete Doom game requires both an engine and a data
+            component.  The data component is considered the "primary" half
+            of the pair.  Packages providing Doom game data should include a
+            <tt>.desktop</tt> file to launch a game with that data.
+
+          </p>
+          <sect1><heading>Example .desktop file</heading>
+<p>
+<example compact="compact">
+<var>[Desktop Entry]</var>
+<var>Name=Freedoom</var>
+<var>GenericName=Clone of the legendary first person shooter Doom</var>
+<var>Comment=First Person Shooter Game</var>
+<var>Exec=/usr/games/boom -iwad /usr/share/games/freedoom/doom2.wad</var>
+<var>Icon=freedoom</var>
+<var>Terminal=false</var>
+<var>Type=Application</var>
+<var>Categories=Game;ActionGame;</var>
+</example></p>
+          <p>
+
+            Note that in the above example, the <tt>.desktop</tt> file
+            references <tt>/usr/games/boom</tt> and so the freedoom package
+            must depend on <tt>boom-engine</tt>.  See <ref id="alternatives">.
+          </p>
+          </sect1>
+        </sect>
         <sect><heading>Virtual packages</heading>
           <p>
 
@@ -143,12 +172,13 @@
 
             <taglist>
               <tag><strong>doom-engine</strong></tag>
-              <item>the code portion of a Doom game. to be depended on if
-              you are a PWAD, say.</item>
+              <item>the code portion of a Doom game.
+              <tag><strong>boom-engine</strong></tag>
+              <item>The code portion of a Doom game supporting the Boom featureset.</item>
               <tag><strong>doom-wad</strong></tag>
-              <item>a Doom IWAD compatible with the vanilla featureset. For use by e.g. engines.</item>
+              <item>a Doom IWAD compatible with the vanilla featureset.</item>
               <tag><strong>boom-wad</strong></tag>
-              <item>a Doom IWAD containing Boom features. For use by e.g. engines.</item>
+              <item>a Doom IWAD containing Boom features.</item>
             </taglist>
 
           </p>
@@ -196,49 +226,27 @@
               <item>Final Doom: plutonia</item>
             </taglist>
 
-          </p><p>
-
-            The original Doom games come in a variety of different versions
-            and free alternatives exist for some of them. Packages should
-            not install files to <tt>/usr/share/games/doom</tt> directly,
-            but instead register an alternative (see <ref
-            id="alternatives">).
-
           </p>
         </sect>
         <sect id="alternatives">
           <heading>Alternatives</heading>
-          <sect1><heading>IWADs</heading>
+          <sect1><heading>Engines</heading>
+
             <p>
-            
-              Packages which provide an IWAD listed in <ref id="iwads">
-              should register an alternative for the filename within the
-              IWAD directory.
 
-            </p><p>
+                Packages providing the virtual package name
+                <tt>doom-engine</tt> should install an alternative for
+                <tt>/usr/games/doom</tt> at priority <strong>50</strong>.
 
-              If the IWAD being provided is an official IWAD (i.e. the
-              commercial game data from ID Software) the alternative should
-              be registered with a priority of <strong>50</strong>.
-
             </p><p>
 
-              If the IWAD being provided is a 3rd-party IWAD (such as
-              <em>freedoom</em>), the alternative should be registered with
-              a priority of <strong>25</strong> or less.
+                Packages providing the virtual package name
+                <tt>boom-engine</tt> should install an alternative for
+                <tt>/usr/games/boom</tt> at priority <strong>50</strong> in
+                addition to their <tt>/usr/games/doom</tt> alternative.
 
             </p>
           </sect1>
-          <sect1><heading>Engines</heading>
-
-            <p>
-
-                Packages providing a Doom engine should install an
-                alternative for <tt>/usr/games/doom</tt> at priority
-                <strong>50</strong>.
-
-            </p>
-          </sect1>
         </sect>
     </chapt>
 

Modified: packages/doom-packaging/version.ent
===================================================================
--- packages/doom-packaging/version.ent	2009-07-05 22:20:12 UTC (rev 9972)
+++ packages/doom-packaging/version.ent	2009-07-05 22:31:40 UTC (rev 9973)
@@ -1,2 +1,2 @@
-<!entity version "2.1">
-<!entity date    "2009-03-04">
+<!entity version "2.2">
+<!entity date    "2009-07-05">