[Midnightbsd-cvs] www: policy.html: add notes on PKGNAME and PORTREVISION

[ctriv at midnightbsd.org]

Log Message:
-----------
add notes on PKGNAME and PORTREVISION

Modified Files:
--------------
    www/docs/mports:
        policy.html (r1.12 -> r1.13)

-------------- next part --------------
Index: policy.html
===================================================================
RCS file: /home/cvs/www/docs/mports/policy.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -L docs/mports/policy.html -L docs/mports/policy.html -u -r1.12 -r1.13
--- docs/mports/policy.html
+++ docs/mports/policy.html
@@ -42,6 +42,30 @@
 
 <p>The following are guidelines for the behavior and layout of a port.  <em>Any time</em> a port is updated or created, it should be checked for compliance with these guidelines.  Note that this is a living document that should be checked from time to time for changes.</p>
 
+<h2>PKGNAME</h2>
+
+<p>(Note that PKGNAME currently includes the version, which is unfortunate and an artifact from our FreeBSD roots.  In time PKGNAME will be renamed, and PKGSUBNAME will renamed to PKGNAME.)</p>
+
+<p>Every PKGSUBNAME must be unique.  This is not currently the case in the tree, but work has begun on this front.</p>
+
+<h2>PORTREVISION</h2>
+
+<p>The PORTREVISION variable should only be incremented when there changes that will affect:</p>
+	<ul>
+		<li>Behaviors. (used to provide the foo widget, changed this to the bar widget).
+		<li>File locations (moved configuration file to $PREFIX/etc/ instead of $PREFIX/$PKGSUBNAME/etc)</li>
+		<li>Dependencies up or down the chain. (some depend bumped a shared lib version, bump so that people will get the new version and link correctly).
+		<li>Other issuse at the port maintainer's discretion.</li>
+	</ul>
+<p>The following are <em>not</em> cause for incrementing the PORTREVISION:</p>
+	<ul>
+		<li>Fixing a broken port.  Version numbers are for tracking packages, not ports.</li>
+		<li>Setting the LICENSE variable</li>
+		<li>Stylistic changes</p>
+	</ul>
+
+<p>PORTREVISION used to be bumped in more cases, due to the way that our cluster software used to work.  The cluster now checks each port for each run.</p>		
+
 <h2>LICENSE</h2>
 
 <p>Every port should define a LICENSE variable with a valid license. A list of valid licenses is printed by the <code>license-list</code> target.  The LICENSE variable should immediately follow the COMMENT variable.</p>