[PATCH] Documentation: User manual, "barebox" section

Robert P. J. Day rpjday at crashcourse.ca
Mon Jun 30 09:34:35 PDT 2014

On Mon, 30 Jun 2014, Sascha Hauer wrote:

> On Mon, Jun 30, 2014 at 10:41:58AM -0400, Robert P. J. Day wrote:
> >
> > Various grammar/font fixes to that section, including adding an
> > additional section describing how to properly do "out of tree"
> > configuration and building.
> >
> > Signed-off-by: Robert P. J. Day <rpjday at crashcourse.ca>
> Thanks for documenting the out of tree build. I always forget how to do
> this. Finally I have a place to look at ;)
> BTW buildinf the documentation out of tree is currently broken. This is
> because we autogenerate the command files:
> 	@$(srctree)/Documentation/gen_commands.py $(srctree) $(srctree)/Documentation/command
> We should generate them in $(objtree), but then we the autogenerated
> command files in another place than the rest of the documentation.
> sphinx expects a single directory though.
> I have no good idea how to solve this, other than copying all doc files
> to $(objtree)/Documentation before calling sphinxs-build.

  hmmmmmm ... i seem to be able to generate the docs out of tree just
fine. i'll check again and make sure. all i'm doing is setting:

  $ export KBUILD_OUTPUT=<dest dir>

and running

  $ make docs

and the sphinx-based documentation appears to be created just fine in
that output/build directory. am i misunderstanding something here?



Robert P. J. Day                                 Ottawa, Ontario, CANADA

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday

More information about the barebox mailing list