Page 1 of 1

How-to compile Docs in CHM format ?

Posted: 27. Feb 2012, 18:29
by Technologov
Normally, when I compile vbox, I get only PDF.
How-to generate the docs in CHM format ?

According to Klaus & Frank:

Set VBOX_WITH_DOCS_CHM = 1 in your LocalConfig.kmk. But it will
require additional build tools. And on Linux you need Wine. That's
the reason it is disabled for Linux hosts by default.

It's rather easy if you're on Windows (just make sure
VBOX_WITH_DOCS_CHM=1 isn't overridden by AutoConfig.kmk or
LocalConfig.kmk). It's the default setting, so I don't think this is an
issue. Building the documentation must be enabled, but as you get the
PDF that's a non-issue.

You need to point VBOX_PATH_HTML_HELP_WORKSHOP to the directory of
hhc.exe (from MS HTML Help Workshop), and the rest should be smooth sailing.

If you're on Linux you might be lucky with WINE, but if my memory
doesn't fool me it's a complete nightmare to get hhc.exe working.
... for now I give up on this.

-Technologov

Re: How-to compile Docs in CHM format ?

Posted: 27. Feb 2012, 18:52
by Perryg
It works if you have the correct version of wine. Version 1.0 works but the newer ones create deprecated errors and fails.

Re: How-to compile Docs in CHM format ?

Posted: 27. Feb 2012, 18:54
by Technologov
Only Wine or also MS HTML workshop ?

Re: How-to compile Docs in CHM format ?

Posted: 27. Feb 2012, 18:55
by Perryg
I also posted this in the tutorial for building the deb package here viewtopic.php?f=31&t=43102

Re: How-to compile Docs in CHM format ?

Posted: 27. Feb 2012, 18:56
by Perryg
Technologov wrote:Only Wine or also MS HTML workshop ?
That would be for creating on Windows not Linux, which I have not been able to do since they added all the wddm stuff. Still waiting for new instruction so I can build Windows version easily again.

Re: How-to compile Docs in CHM format ?

Posted: 27. Feb 2012, 19:02
by Technologov
"can build Windows version" ?

Full Windows version of VirtualBox can be built on Linux ?
(unlikely, due to dependency on Microsoft DDK for drivers, such as "vboxdrv")

Re: How-to compile Docs in CHM format ?

Posted: 27. Feb 2012, 19:08
by Perryg
I'm not following you Alex. We are talking about building the DOCs CHM right?
That is doable in Linux with VBOX_WITH_DOCS_CHM := 1 in your LocalConfig.kmk
But only with the right version of wine.

I don't build the Windows version of VirtualBox any more since they changed the build and it errors out, and can't until they post the changes they made or the necessary patches.

Re: How-to compile Docs in CHM format ?

Posted: 15. Mar 2012, 17:45
by frank
Actually we are using Wine on Linux as well to build the documentation for all builds. We do not use Windows, therefore building CHM on Windows is not tested.