search

zultron / rtai-deb

RTAI Debian packaging
Other
2 stars 1 forks source link

Missing docs break RTAI package after update #2

Closed zultron closed 9 years ago

zultron commented 9 years ago

After update to latest RTAI master, package build breaks.

dh_installdocs -s
cp: cannot stat `doc/generated/html/api': No such file or directory
dh_installdocs: cp -a doc/generated/html/api debian/rtai-doc/usr/share/doc/rtai-doc returned exit code 1
make: *** [binary-indep] Error 2

This is worked around in 1854509, but that's not a clean fix, and I'd rather get to the root of this before simply ripping out the docs.

An attempt to get doc builds working in 1535385 was aborted after fop.sh wasn't found; I believe that is renamed to fop in the asciidoc package.

No more time to work on this ATM, so the work-around will have to do for now.

@ShabbyX, FYI.

ShabbyX commented 9 years ago

I'll give it a look. I hadn't tested (and touched) that part for a long time!

So you think it's not RTAI, but the version of asciidoc package, right? I'm guessing that's fixable through configure.ac, right?

Anyway, I'll take a look and let you know.

zultron commented 9 years ago

Sorry I didn't dig deeper. I think that configure.ac, or perhaps an asciidoc m4 macro file, should be taught to look for the fob executable as well as fob.sh. Getting past that point might possibly be the final resolution; it's just as far as I made it.

The other avenue to explore is whether there used to be a doc/generated/html/api directory that disappeared.

zultron commented 9 years ago

Looks like docs were zapped here: https://github.com/ShabbyX/RTAI/commit/3da291daa40196efe6dc0a13e414a7f28912a7a0

zultron commented 9 years ago

So the PR at shabbyx/rtai#20 gets us past the fop.sh/fop problem and through ./configure.

A make -C doc completes, though only after lots of warnings. I'm missing the big picture about what targets generate what documentation, so I'll have to leave it here for now.

ShabbyX commented 9 years ago

Ah, I had seen that commit of Alec's. I imagined since it removes html files, they must have been generated by doxygen. Isn't it then possible to use doxygen to generate them again? It wouldn't make sense to keep generatable artifacts in the repository, although it does help with people who don't have doxygen installed.

Thanks for the PR, I'll work on the rest.

zultron commented 9 years ago

Ok, it looks like ./configure --enable-doc --enable-dbx; make -C doc/doxygen builds (successfully, but with lots of warnings) a doc/doxygen/api directory that appears to contain the same things removed in ShabbyX/RTAI@3da291d. The deps added here are more than enough to build those. I'll add that into the package.