[RTEMS Project] #2940: rtems-docs output and catalogue.xml verison numbering is wrong.

[RTEMS trac]

#2940: rtems-docs output and catalogue.xml verison numbering is wrong.
---------------------------+--------------------------
 Reporter:  Chris Johns    |       Owner:  Chris Johns
     Type:  defect         |      Status:  closed
 Priority:  high           |   Milestone:  4.11.2
Component:  Documentation  |     Version:  4.11
 Severity:  major          |  Resolution:  fixed
 Keywords:                 |
---------------------------+--------------------------

Comment (by Chris Johns):

 Replying to [comment:1 Amar Takhar]:
 > Can you elaborate what's wrong with it?  The version number is supposed
 to be in conf.py.  No changeable information should ever be in common/*
 this is why it is called *common*.

 The version numbers in 4.11.1 are 4.11.0 which is wrong. There are no
 version numbers in common and none are being added.

 > The --release option is a bad idea, what should happen is the version is
 changed to the next release then tagged, after that the version is again
 bumped to the next version.  A commandline option would allow for a
 version existing outside of the repo that doesn't exist in the repo that's
 very bad for documentation since people keep it around forever.  It's like
 someone saying they have docs for 4.13 but no rtems 4.13 release exists in
 rtems-docs.

 Yes an option is a bad idea, I verbalized a need I had to generate a
 catalogue for 4.11.1 because that release does not have one and I wanted
 to avoid adding a 3rd type of doc packaging. I currently have legacy which
 is pre-ReST and what we have now which contains a catalogue.

 I think bumping the release to the next in the repo is a bad idea because
 any docs generated on that branch will have a real release number and once
 a release is made you cannot distinguish between a build before the
 release and release. I am not a fan of odd/evening numbering or special
 encoding in version numbers to mean special things.

 The 4.11 branch version will always be '4.11 (branch)' and I will handle
 the release labeling in the release procedure.

--
Ticket URL: <http://devel.rtems.org/ticket/2940#comment:4>
RTEMS Project <http://www.rtems.org/>
RTEMS Project