Gentoo Archives: gentoo-doc

From: Joshua Saddler <nightmorph@g.o>
To: gentoo-doc@l.g.o
Subject: [gentoo-doc] New version format
Date: Mon, 06 Dec 2010 11:45:33
Message-Id: 20101206034444.7b1b1fe2@angelstorm
I made a few changes to our Tips'n'Tricks guide:

http://www.gentoo.org/proj/en/gdp/doc/doc-tipsntricks.xml

What:

New format for the <version> string. No more decimal numbers from
now on. Just whole numbers. Only <version>3</version>,
<version>11</version>, <version>101</version>, etc.

Why:

This is something we started doing back in 2007 or so. I've been
working on getting this standardized. Whole numbers really are much
simpler. The "point-whatever" is entirely meaningless, since we don't
have archived, versioned documentation. It has no relation to the
actual content of the document.

When:

For all new documents from this point forward. For old documents not
yet using the new format, *the next time* you make a change to it,
bump the version upward to the nearest whole number:

9.7 -> 10
4.13 -> 5
0.65 -> 1
1.24 -> 2

. . . and so on. Include the new <version> with the rest of your
content commit.

* * * Exception * * *

DON'T apply the new version format to metadoc.xml. I want to keep
metadoc's decimal number for now. It's more useful as an indicator
of how frequently the file is changed. (I realize that its version
string doesn't match CVS history. CVS says 234 revisions,
internal <version> says 1.156 - no idea why the huge disparity.)


Thanks!

Attachments

File name MIME type
signature.asc application/pgp-signature

Replies

Subject Author
Re: [gentoo-doc] New version format Tobias Heinlein <keytoaster@g.o>