[Libguestfs] [PATCH 04/16] gobject: Add infrastructure to build gtk-doc

[Matthew Booth]

On 03/27/2012 04:13 PM, Richard W.M. Jones wrote:
> On Tue, Mar 27, 2012 at 04:00:46PM +0100, Matthew Booth wrote:
>> diff --git a/gobject/docs/Makefile.am b/gobject/docs/Makefile.am
>> new file mode 100644
>> index 0000000..0dd43f6
>> --- /dev/null
>> +++ b/gobject/docs/Makefile.am
>> @@ -0,0 +1,105 @@
>> +## Process this file with automake to produce Makefile.in
>
> Remove this and put in the full header, copied from another
> Makefile.am.
>
>> +# We require automake 1.6 at least.
>> +AUTOMAKE_OPTIONS = 1.6
>
> Earliest automake (in RHEL 5) is 1.9 so I think we're safe.
>
>> +# This is a blank Makefile.am for using gtk-doc.
>> +# Copy this to your project's API docs directory and modify the variables to
>> +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
>> +# of using the various options.
>
> This boilerplate can also be removed.
>
> [...]
>
>> diff --git a/gobject/docs/guestfs-sections.txt b/gobject/docs/guestfs-sections.txt
>> new file mode 100644
>> index 0000000..19b0de8
>> --- /dev/null
>> +++ b/gobject/docs/guestfs-sections.txt
>> @@ -0,0 +1,689 @@
>> +<SECTION>
>> +<FILE>guestfs-gobject</FILE>
>> +<TITLE>GuestfsAddDomain</TITLE>
>
> etc.
>
> Is this file supposed to be checked in?  It seems generated to me.

It is initially automatically generated, but can be subsequently 
manually edited.

Matt
-- 
Matthew Booth, RHCA, RHCSS
Red Hat Engineering, Virtualisation Team

GPG ID:  D33C3490
GPG FPR: 3733 612D 2D05 5458 8A8A 1600 3441 EA19 D33C 3490