[avr-libc-dev] Generating and Publishing AVR-Libc Documentation

[Jonathan Taylor]

Hello Developers!

While working on

bug #43261: symbols in documentation are getting their leading and trailing
"__" stripped by doxygen <https://savannah.nongnu.org/bugs/?43261>

I confirmed that the problem was with doxygen. I also noticed that Using
the GNU tools <http://www.nongnu.org/avr-libc/user-manual/using_tools.html>
has "Automatically generated by Doxygen 1.8.7 on Tue Aug 12 2014." at the
bottom. I'd like to have the documentation fixed and published before
closing out the bug.

What is the process for (re)generating and publishing documentation to
http://www.nongnu.org/avr-libc ?

- Jonathan

[Joerg Wunsch]

Hi Jonathan,

many thanks for your work on the documentation!

Post by Jonathan Taylor
What is the process for (re)generating and publishing documentation to
http://www.nongnu.org/avr-libc ?

It's unfortunately a little complicated, as it still requires
the use of CVS, and quite a bit of tweaking.

The CVS URL is

***@cvs.savannah.nongnu.org:/web/avr-libc

The process of committing a new version is described in the
documentation itself. For reference, I'm appending that
document here.

If all that sounds too complicated for you, I can do it myself.
Which version of doxygen do I need? I could upgrade to 1.8.11
without troubles here (builds straight from my FreeBSD ports
tree).

[Joerg Wunsch]

import avr-libc/user-manual AVR-LIBC $release
The meta variable $userid is (obviously) your User ID on savannah,
while $release is the symbolic release tag. While this tag is mostly
unimportant, the current convention uses "r_X_Y_Z", with X.Y.Z being
the avr-libc version number this documentation set belongs to (e. g.
"r_1_0_2" for the avr-libc 1.0.2 docs).

Offhand, I'm not sure what would be more appropriate to handle a
re-import of an existing version here. Either re-use the previous
release tag (r_2_0_0 right now), or use a new one (r_2_0_0_1).

Probably the latter. I see I've been doing it that way at least
once before (r_1_8_0_1).