nightmorph 10/12/06 11:24:51 Modified: doc-tipsntricks.xml Log: update doc tips and tricks for new revbump policy
Revision Changes Path 1.28 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.28&view=markup plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.28&content-type=text/plain diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?r1=1.27&r2=1.28 Index: doc-tipsntricks.xml =================================================================== RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v retrieving revision 1.27 retrieving revision 1.28 diff -u -r1.27 -r1.28 --- doc-tipsntricks.xml 28 Apr 2010 19:26:07 -0000 1.27 +++ doc-tipsntricks.xml 6 Dec 2010 11:24:51 -0000 1.28 @@ -1,7 +1,7 @@ <?xml version='1.0' encoding="UTF-8"?> <!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.27 2010/04/28 19:26:07 nightmorph Exp $ --> +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.28 2010/12/06 11:24:51 nightmorph Exp $ --> <guide> <title>Documentation Development Tips & Tricks</title> @@ -23,8 +23,8 @@ <license/> -<version>4</version> -<date>2010-04-28</date> +<version>5</version> +<date>2010-12-06</date> <chapter> <title>Checking out the web site files</title> @@ -346,8 +346,8 @@ <p> Conforming to the policy, you <e>must</e> bump a version/date when you make -certain changes (most actually). Although the version is less important (SwifT -will still kill you if you forget it) the date tells our users when the +certain changes (most actually). Although the version is less important (the GDP +lead will still kill you if you forget it) the date tells our users when the document was last modified. </p> @@ -364,11 +364,29 @@ its content. </p> +<!-- Since 2007 or so we've been moving toward simple whole numbers; +No need for complicated decimals <p> Another common mistake is to update the version number as if it were a decimal number. It's not. <c>3.9</c> should become <c>3.10</c>, not <c>4.0</c>, nor <c>3.91</c>. </p> +--> + +<p> +Another common mistake is to update the version number using decimals. You +shouldn't do this. The version is a simple whole number. Each update should +increment it by one. <c>9</c> should become <c>10</c>, not <c>9.1</c>. For old +documents not yet using the simpler whole number versioning, please increment it +to the nearest whole number. So <c>4.67</c> should become <c>5</c>, <c>1.2</c> +should become <c>2</c>, and so on. +</p> + +<impo> +The exception to this rule is <path>/doc/en/metadoc.xml</path>. Metadoc should +still use the existing point version scheme. So <c>1.119</c> becomes <c>1.120</c>, not +<c>1.12</c>. +</impo> </body> </section>
