GNOME Bugzilla – Bug 749162
Documentation improvements and man pages
Last modified: 2018-11-03 11:06:49 UTC
I started fixing some typos, then I started adding docbook tags where appropriate and while I was at it I started editing some sentences to sound a bit better. From there it all went downhill and in the end I reworked the command line tools documentation to be able to generate man pages from it. :)
Created attachment 303148 [details] [review] validate: Go back to the validate dir after submodule init
Created attachment 303149 [details] [review] validate: Reshape documentation Fix some errors, use more Docbook tags and split each command reference in its own file.
Created attachment 303150 [details] [review] validate: Generate man pages from the Docbook documentation
Ha ha, thanks for reassigning. Wrong `git bz` invocation from my shell history. %-)
Review of attachment 303148 [details] [review]: OK
Thanks for that! I try to build the man page but am getting: make[3]: Entering directory '/home/thiblahute/devel/pitivi/1.0-uninstalled/gst-devtools/validate/docs/validate' MAN gst-validate.1 warning: failed to load external entity "manpages/docbook.xsl" cannot parse manpages/docbook.xsl Not sure what is happening. Apart from that it looks good.
Review of attachment 303149 [details] [review]: OK
(In reply to Thibault Saunier from comment #6) > make[3]: Entering directory > '/home/thiblahute/devel/pitivi/1.0-uninstalled/gst-devtools/validate/docs/ > validate' > MAN gst-validate.1 > warning: failed to load external entity "manpages/docbook.xsl" > cannot parse manpages/docbook.xsl > > Not sure what is happening. Oops, I forgot to submit a local fix to gtk-doc. Done now, see bug #749210. I'm not sure how to proceed. Should I just ignore gtk-doc errors instead of depending on an unreleased gtk-doc version or given that manpages are off by default it is ok?
(In reply to Emanuele Aina from comment #8) > Oops, I forgot to submit a local fix to gtk-doc. Done now, see bug #749210. > > I'm not sure how to proceed. Should I just ignore gtk-doc errors instead of > depending on an unreleased gtk-doc version or given that manpages are off by > default it is ok? Any way you check it in configure.ac?
Attachment 303148 [details] pushed as 1286989 - validate: Go back to the validate dir after submodule init Attachment 303149 [details] pushed as 2c3d0c9 - validate: Reshape documentation
Not closing until we have a check to generate the manpages.
The bug #749210 fix has been merged, but other than checking for the to-be-released gtk-doc version number (1.22.1) with pkg-config I don't think there are cleaner ways to check if the installed gtk-doc has it.
I would go forward with the change. The man-pages work on linux, I think one could also install an alias in the xmlcatalog to make it work on macosx.
(In reply to Emanuele Aina from comment #12) > The bug #749210 fix has been merged, but other than checking for the > to-be-released gtk-doc version number (1.22.1) with pkg-config I don't think > there are cleaner ways to check if the installed gtk-doc has it. That sounds clean to me. We should depend on 1.22.1 only if the user specified --enable-man though.
-- GitLab Migration Automatic Message -- This bug has been migrated to freedesktop.org's GitLab instance and has been closed from further activity. You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.freedesktop.org/gstreamer/gst-devtools/issues/13.