[libvirt] [PATCH] Generate HACKING from docs/hacking.html.in

[Matthias Bolte]

2010/11/11 Eric Blake <eblake at redhat.com>:
> On 11/11/2010 01:39 PM, Matthias Bolte wrote:
>> Tweak pre tags in docs/hacking.html.in to achieve proper
>> indentation of their plaintext representation.
>>
>> Also use more b/i/code tags in docs/hacking.html.in.
>> ---
>>  HACKING              |  602 +++++++++++++++++++++++++++++---------------------
>
> A lot of this diff is whitespace; the rest looks like it is pulling in
> missed bits.  Overall, it looks pretty decent; and it's certainly more
> maintainable!
>
>>  Makefile.am          |    8 +
>>  docs/hacking.html.in |  351 ++++++++++++++++--------------
>
> Would you mind splitting this into two patches?  One that cleans up just
> hacking.html.in, and the rest that covers going from a clean source file
> into the new generated HACKING file.

I did that now.

>> +++ b/Makefile.am
>> @@ -48,6 +48,8 @@ EXTRA_DIST = \
>>  pkgconfigdir = $(libdir)/pkgconfig
>>  pkgconfig_DATA = libvirt.pc
>>
>> +all: NEWS HACKING
>
> Hmm.  This means that everyone will attempt to build NEWS and HACKING,
> even if they don't have the prerequisite tools.

I changed that to:

syntax-check: $(top_srcdir)/HACKING

>>         $(XSLTPROC) --nonet $(top_srcdir)/docs/news.xsl       \
>> @@ -56,6 +58,12 @@ NEWS: $(top_srcdir)/docs/news.xsl $(top_srcdir)/docs/news.html.in
>>          | perl -pe 's/[ \t]+$$//'                            \
>>          > $@-t && mv $@-t $@ ; fi );
>>
>> +HACKING: $(top_srcdir)/docs/hacking1.xsl $(top_srcdir)/docs/hacking2.xsl \

> If HACKING stays in git, then it must also reside in $(srcdir) rather
> than $(builddir), which means this rule needs a bit of tweaking to be
> VPATH-friendly.

I think it should stay in git and changed the rule to

$(top_srcdir)/HACKING: ...

I also tested it in a VPATH build and it works as it should.

v2 is attached.

Matthias
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-docs-Prepare-hacking.html.in-to-generate-HACKING-fro.patch
Type: text/x-diff
Size: 21059 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20101112/8920ae26/attachment-0002.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0002-Generate-HACKING-from-docs-hacking.html.in.patch
Type: text/x-diff
Size: 39222 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20101112/8920ae26/attachment-0003.bin>