[PATCH xserver] dmx-doc: remove from git the linuxdoc generated files

Gaetan Nadon memsize at videotron.ca
Mon Jan 11 06:35:44 PST 2010


On Sun, 2010-01-10 at 14:06 -0800, Keith Packard wrote:

> On Sun, 10 Jan 2010 16:06:51 -0500, Gaetan Nadon <memsize at videotron.ca> wrote:
> 
> > The dmx and scaled text files are generated from sgml files.
> > The linuxdoc program is used to generated them.
> 
> We've generally been distributing the .txt files with the .tar.gz
> package so that people don't have to figure out how to get linuxdoc or
> doxygen to run. That will take some additional effort to get that to
> happen when doing 'make distcheck' which I do for each release.
> 


The .txt generated by linuxdoc isn't a problem so as long as it isn't
built by default, which is the case now. We can ignore this patch.

The html generated by doxygen are a problem. It breaks "make dist". By
default, html files are not generated, so the tarball creation fails.


        hw/dmx/doc
        make[3]: *** No rule to make target `html/ChkNotMaskEv_8h_source.html', needed by `distdir'.  Stop.


This is the subject of the other patch (which I need to reparent):


                                        
        [PATCH xserver] dmx-doc: do not
        distribute generated html files.

It won't stop a knowledgeable person from creating a tarball for a
release, but it discourages developers from routinely running dist or
distcheck as a good free test case. 

If the docs don't change often, it might be less work to check them in,
update them before a module release  and leave the makefile doc target
unreachable by the build. Also, I noticed the docs aren't "installed". 

Thanks!

Gaetan

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.x.org/archives/xorg-devel/attachments/20100111/1d50b8d4/attachment.htm 


More information about the xorg-devel mailing list