xfce4-docs update

Brian J. Tarricone brian at tarricone.org
Thu Sep 24 01:06:18 CEST 2009

Hash: SHA1

On 09/23/2009 03:32 PM, Jannis Pohlmann wrote:
> On Thu, 24 Sep 2009 00:16:51 +0200
> Mike Massonnet <mmassonnet at gmail.com> wrote:
>> I had like to see the projects including sub-modules for the
>> documentation not to depend on any extra build configuration. It would
>> be really great to have the xfce-docs repo to always generate the
>> output in html, etc and just have an additionnal install rule in the
>> different projects.

I think you misunderstand what git submodules do.  It's not like having
a symlink to a separate directory of your hard drive.  The submodule
gets a fresh copy checked out in the tree of the main module.

> I'm not sure what you mean with extra build configuration. Of course
> projects including xfce4-docs as a git submodule will have to add
> *something* to their configure scripts and/or makefiles to generate and
> install the docs. 


> And since we also want documentation people to be able to install
> xfce4-docs on its own to test it, the easiest way is to configure and
> build it along with the individual projects using AC_CONFIG_SUBDIRS().
> This will also pass over the prefix and other build options from the
> project to the docs makefiles. I don't think an additional install
> rule is that powerful without added hacks.
> The project also needs to check for the dependencies required for
> building the docs, although I guess that could be handled by xfce4-docs
> in its own configure, now that we use AC_CONFIG_SUBDIRS().

Right, just leave that in the xfce4-docs configure.  If configure for
xfce4-docs fails, that will be a fatal error for the 'main' configure
script too.

Ideally our XDT_DOCS() macro would also add a --disable-docs option to
avoid building the docs entirely for people who don't have the required
deps and/or don't care, in which case configure in the xfce4-docs subdir
wouldn't even get run.

> BTW, I think we might be able move the crossref python module into
> xfce4-docs and sneak it into the python loading path, thus dropping it
> as an external dependencies which we have to maintain separately.

Ah, that would be really nice.

Version: GnuPG v2.0.11 (GNU/Linux)


More information about the Xfce4-dev mailing list