After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 672710 - Use new documentation infrastructure
Use new documentation infrastructure
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
1.18
Other Linux
: Normal normal
: 1.19
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks: 681609
 
 
Reported: 2012-03-23 18:14 UTC by Javier Jardón (IRC: jjardon)
Modified: 2012-08-31 13:39 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
Use new documentation infraestructure (4.47 KB, patch)
2012-03-23 18:15 UTC, Javier Jardón (IRC: jjardon) 		none Details | Review
Use new documentation infraestructure.v2 (137.93 KB, patch)
2012-08-21 15:11 UTC, Javier Jardón (IRC: jjardon) 		needs-work Details | Review
Use new documentation infraestructure.v3 (138.54 KB, patch)
2012-08-31 05:02 UTC, Javier Jardón (IRC: jjardon) 		committed Details | Review

Description Javier Jardón (IRC: jjardon) 2012-03-23 18:14:53 UTC 
Patch following
Comment 1 Javier Jardón (IRC: jjardon) 2012-03-23 18:15:45 UTC 
Created attachment 210459 [details] [review]
Use new documentation infraestructure
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2012-03-23 20:59:07 UTC 
Hmm, I will postpone this a bit. Right now I am using my work laptop a lot and this still runs ubuntu lucid where I don't find yelp-tools in the packages.
Comment 3 Javier Jardón (IRC: jjardon) 2012-08-09 18:48:43 UTC 
Hey Stefan, what about jhbuild buildone yelp-tools gtk-doc ? ;)
Comment 4 Javier Jardón (IRC: jjardon) 2012-08-21 15:11:27 UTC 
Created attachment 222028 [details] [review]
Use new documentation infraestructure.v2

New version fixing some issues
Comment 5 Stefan Sauer (gstreamer, gtkdoc dev) 2012-08-24 10:19:51 UTC 
Review of attachment 222028 [details] [review]:

::: configure.ac
@@ +213,3 @@
+dnl Documentation
+dnl
+YELP_HELP_INIT

We need to make this conditional for bootstrap reasons. People need to be able to build without yelp tools installed (and then get no user-docs).

@@ +274,2 @@
     && AC_MSG_NOTICE([** XML PDF support enabled, using $DBLATEX$FOP]) \
     || AC_MSG_NOTICE([   XML PDF support disabled, no fop available])

Please tell in summary if user-docs are enabled or disabled.

::: help/Makefile.am
@@ +3,1 @@
 SUBDIRS = manual

needs to stay conditional.

::: help/manual/Makefile.am
@@ +1,1 @@
+@YELP_HELP_RULES@

Need to be conditional (if HAVE_YELP_TOOLS)
Comment 6 Stefan Sauer (gstreamer, gtkdoc dev) 2012-08-24 10:33:46 UTC 
I also saw this, it was not happening before.

  GEN    el/
Warning: Could not merge el translation for msgid:
You can also use <INCLUDE> ... </INCLUDE> to specify the #include files which are shown in the synopsis sections. It contains a comma-separate list of #include files, without the angle brackets. If you set it outside of any sections, it acts for all sections until the end of the file. If you set it within a section, it only applies to that section.
Comment 7 Javier Jardón (IRC: jjardon) 2012-08-31 05:02:08 UTC 
Created attachment 223022 [details] [review]
Use new documentation infraestructure.v3

Updated patch with your comments. gtk-doc builds fine even if you do not have yelp-tools
Comment 8 Stefan Sauer (gstreamer, gtkdoc dev) 2012-08-31 13:39:43 UTC 
Thanks. Pushed!