Re: [IMP-dev] NBL cleanup and other small patches
Daniel Russel wrote: >> 'scons doc'. You do, however, need to have a complete DocBook toolchain >> installed. > Well, I guess flute doesn't have such then (although it does seem to > have some of docbook installed) > scons doc > blah, blah, blah > scons *** Do not know how to make target 'doc'. Stop.
Oh, sorry. It should be 'kernel/doc'. Forgot that we moved all the kernel stuff to a subdirectory some time ago.
> I haven't used docbook. For what we have so far, doxygen is much simpler > (and prettier :-), but perhaps you have some more involved directions to > take things. Docbook certain went overboard on the markup :-)
Indeed - it's XML. The DocBook stuff right now is very basic, because most of today's documentation is API documentation. But once we have less technical users - as is the long term intention - they will need more traditional book-style documentation (of course pointing them to the docbook docs for any technical stuff).
Ben
> Oh, sorry. It should be 'kernel/doc'. Forgot that we moved all the > kernel stuff to a subdirectory some time ago. I didn't know scons targets could look like that :-) Learn something every day. Does that syntax build all the targets in that directory?
How come it builds everything else first? Is env.Default added to everything rather than being the default?
Thanks.
Daniel Russel wrote: >> Oh, sorry. It should be 'kernel/doc'. Forgot that we moved all the >> kernel stuff to a subdirectory some time ago. > I didn't know scons targets could look like that :-) Learn something > every day. Does that syntax build all the targets in that directory?
scons targets are files, just like make, except that it understands directory structure, so you can use paths. And yes, a directory depends on all targets in that directory. For example, 'scons .' would make sure all files are up to date in the source tree, but 'scons /' would build all targets anywhere in the filesystem (so would do any install rules, for example).
> How come it builds everything else first? Is env.Default added to > everything rather than being the default?
Currently the examples are considered part of the documentation, and 'scons doc' runs them. You can't run the examples without having IMP built first, so that gets pulled in as a dependency.
Ben
participants (2)
-
Ben Webb -
Daniel Russel