[PATCH 1/4] dmx: Ignore linuxdoc generated docs

[Gaetan Nadon]

On Wed, 2010-04-14 at 13:47 -0500, Yaakov (Cygwin/X) wrote:

> On 2010-03-25 03:55, Yaakov (Cygwin/X) wrote:
> > This commit would also include the complete removal of dmx.txt and
> > scaled.txt as noted in the diffstat, but apparently that makes the patch
> > too long for the list's filters so I'm omitting that part here.
> >
> >  hw/dmx/doc/.gitignore |    8 +
> >  hw/dmx/doc/dmx.txt    | 2989 -------------------------------------------------
> >  hw/dmx/doc/scaled.txt |  579 ----------
> >  3 files changed, 8 insertions(+), 3568 deletions(-)
> >  delete mode 100644 hw/dmx/doc/dmx.txt
> >  delete mode 100644 hw/dmx/doc/scaled.txt
> 
> What I hadn't realized at the time I wrote this patch (which hasn't been 
> pulled yet) is that dmx.txt and scaled.txt are also in EXTRA_DIST. 
> Removing these files from git will require that those running make 
> dist{,check} -- primarily the release managers -- to have linuxdoc 
> installed, otherwise:
> 
> make[3]: Entering directory `hw/dmx/doc'
> make[3]: *** No rule to make target `dmx.txt', needed by `distdir'.  Stop.
> make[3]: Leaving directory `hw/dmx/doc'
> make[2]: *** [distdir] Error 1
> 
> Keith, Peter, this will affect you first, objections?
> 

Not specific to xserver, creating a tarball requires building all docs
and requires all the doc toolchain. In some cases, the doc generated
files are included in the tarball in case the platform builder does not
have those tools. What is different in this case is that the source is
both in git and generated.

The one remaining alternative that has not been submitted for review is
to .gitignore those 2 files. Once every blue moon when the source is
updated, the developer with have to use git with a force flag to
override what .gitignore says.

I wrote this table to enumerate all this stuff:
http://www.x.org/wiki/Development/Documentation/WritingDocumentation

Thanks for independently verifying that there is an issue yet to be
solved here.


> 
> Yaakov
> Cygwin/X
> _______________________________________________
> xorg-devel at lists.x.org: X.Org development
> Archives: http://lists.x.org/archives/xorg-devel
> Info: http://lists.x.org/mailman/listinfo/xorg-devel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.x.org/archives/xorg-devel/attachments/20100414/e2697fe8/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: This is a digitally signed message part
URL: <http://lists.x.org/archives/xorg-devel/attachments/20100414/e2697fe8/attachment.pgp>