svn commit: r51324 - head/en_US.ISO8859-1/books/porters-handbook/versions

Author: mat
Date: Wed Dec 20 08:33:22 2017
New Revision: 51324
URL: https://svnweb.freebsd.org/changeset/doc/51324

Log:
  Add a template and a bit of an explanation for the versions
  descriptions.
  
  Sponsored by:	Absolight

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/versions/chapter.xml

Modified: head/en_US.ISO8859-1/books/porters-handbook/versions/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/versions/chapter.xml	Wed Dec 20 08:13:57 2017	(r51323)
+++ head/en_US.ISO8859-1/books/porters-handbook/versions/chapter.xml	Wed Dec 20 08:33:22 2017	(r51324)
@@ -5,6 +5,33 @@
      $FreeBSD$
 -->
 
+<!--
+
+README FIRST:
+
+The format of each entry is:
+
+	  <row>
+	    <entry>[version number]</entry>
+	    <entry><revnumber>[revision of the bump]</revnumber></entry>
+	    <entry>[date of revision]</entry>
+	    <entry>[FreeBSD version] [long-ish description of why the version was
+	      bumped.]</entry>
+	  </row>
+
+The [FreeBSD version] is usually XY-CURRENT or XY-STABLE.
+
+In some cases, the changes described were not committed at the same
+time when the version was bumped, in this case, add the revision to
+the description, like, for example, for 1200028.
+
+You do not need to add all the extra xml markup in the description
+that will make it look better, what is important is to document
+things.  Keep in mind though, that this is xml, so if you need a &, it
+is spelled &amp;, < is &lt; and > is &gt;.
+
+-->
+
 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink=
   "http://www.w3.org/1999/xlink" version="5.0" xml:id="versions">
 
_______________________________________________
[email protected] mailing list
https://lists.freebsd.org/mailman/listinfo/svn-doc-all
To unsubscribe, send any mail to "[email protected]"