Installing/Building documentation

[Felipe Contreras]

Hi,

While cleaning the documentation generation stuff I came up with an
issue; ENABLE_PLUGIN_DOCS is disabled if ENABLE_GTK_DOC is disabled.

I started to fix the issue but I realized that it might not be the
best way to do it.

ENABLE_PLUGIN_DOCS should be independent of ENABLE_GTK_DOC, actually
perhaps it should be renamed to BUILD_GTK_DOC. Then we could have:

 * ENABLE_GTK_DOC and BUILD_GTK_DOC: just like ENABLE_GTK_DOC=y
 * ENABLE_GTK_DOC and not BUILD_GTK_DOC: just like ENABLE_GTK_DOC=n
 * not ENABLE_GTK_DOC: don't install documentation (useful in embedded
systems maybe)

Then AG_GST_PLUGIN_DOCS could check for ENABLE_GTK_DOC instead.

What do you think?

Best regards.

--
Felipe Contreras

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
gstreamer-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/gstreamer-devel

[Stefan Sauer]

Hi,

Felipe Contreras schrieb:
> Hi,
>
> While cleaning the documentation generation stuff I came up with an
> issue; ENABLE_PLUGIN_DOCS is disabled if ENABLE_GTK_DOC is disabled.
 >
The plugin docs are build using gtk-doc and some own hacks. So if you disable
gtk-doc you get no api and no plugin docs.

Stefan

>
> I started to fix the issue but I realized that it might not be the
> best way to do it.
>
> ENABLE_PLUGIN_DOCS should be independent of ENABLE_GTK_DOC, actually
> perhaps it should be renamed to BUILD_GTK_DOC. Then we could have:
>
>  * ENABLE_GTK_DOC and BUILD_GTK_DOC: just like ENABLE_GTK_DOC=y
>  * ENABLE_GTK_DOC and not BUILD_GTK_DOC: just like ENABLE_GTK_DOC=n
>  * not ENABLE_GTK_DOC: don't install documentation (useful in embedded
> systems maybe)
>
> Then AG_GST_PLUGIN_DOCS could check for ENABLE_GTK_DOC instead.
>
> What do you think?
>
> Best regards.
>

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
gstreamer-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/gstreamer-devel

[Felipe Contreras]

On Wed, May 21, 2008 at 10:35 PM, Stefan Kost <[hidden email]> wrote:

> Hi,
>
> Felipe Contreras schrieb:
>>
>> Hi,
>>
>> While cleaning the documentation generation stuff I came up with an
>> issue; ENABLE_PLUGIN_DOCS is disabled if ENABLE_GTK_DOC is disabled.
>
>>
> The plugin docs are build using gtk-doc and some own hacks. So if you
> disable gtk-doc you get no api and no plugin docs.

Unless you are compiling from a tarball, where the docs are already
built and distributed.

--
Felipe Contreras

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
gstreamer-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/gstreamer-devel

[Felipe Contreras]

On Wed, May 21, 2008 at 11:22 PM, Felipe Contreras
<[hidden email]> wrote:

> On Wed, May 21, 2008 at 10:35 PM, Stefan Kost <[hidden email]> wrote:
>> Hi,
>>
>> Felipe Contreras schrieb:
>>>
>>> Hi,
>>>
>>> While cleaning the documentation generation stuff I came up with an
>>> issue; ENABLE_PLUGIN_DOCS is disabled if ENABLE_GTK_DOC is disabled.
>>
>>>
>> The plugin docs are build using gtk-doc and some own hacks. So if you
>> disable gtk-doc you get no api and no plugin docs.
>
> Unless you are compiling from a tarball, where the docs are already
> built and distributed.

I created a bug report for that:
http://bugzilla.gnome.org/show_bug.cgi?id=535074

Best regards.

--
Felipe Contreras

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
gstreamer-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/gstreamer-devel