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 687563 - Port to new documentation infrastructure
Port to new documentation infrastructure
Product: pitivi
Classification: Other
Component: Documentation
Other Linux
: Normal blocker
: 0.91
Assigned To: Pitivi maintainers
Pitivi maintainers
: 685058 704626 (view as bug list)
Depends on:
Blocks: 681609
Reported: 2012-11-04 13:37 UTC by Oliver Propst
Modified: 2013-09-30 15:08 UTC
See Also:
GNOME target: ---
GNOME version: ---

port to new documentation infrastructure (4.35 KB, patch)
2012-11-04 13:37 UTC, Oliver Propst
none Details | Review
Use-yelp-tools-instead-gnome-doc-utils.v2 (3.26 KB, patch)
2012-12-11 04:37 UTC, Javier Jardón (IRC: jjardon)
needs-work Details | Review

Description Oliver Propst 2012-11-04 13:37:50 UTC
Created attachment 228024 [details] [review]
port to new documentation infrastructure

Use yelp-tools instead of gnome-doc-utils
Comment 1 Matthias Clasen 2012-11-10 23:10:28 UTC
would be nice to get this merged, so we can close the book on new documentation infrastructure porting...
Comment 2 Jean-François Fortin Tam 2012-11-11 00:47:08 UTC
Hi there, I'm far from knowledgeable about packaging/build scripts, but I'll trust that you know what you're doing here :)

Some initial errors I've found:
- You say "please install yelp-tool", but yelp-tool doesn't exist. Shouldn't it be "\nPlease install the yelp-tools package"   ?
- Some of your changes add trailing whitespaces at the end of lines (at least that's what git tells me)
- It breaks the build. Please ensure you run "./ && make" and that it works... In my case, it says:

make[2]: Nothing to be done for `all-am'.
make[2]: Leaving directory `/home/jeff/pitivi-git/pitivi/data'
make[1]: Leaving directory `/home/jeff/pitivi-git/pitivi/data'
Making all in help
make[1]: Entering directory `/home/jeff/pitivi-git/pitivi/help'
Makefile:452: *** missing separator.  Stop.
make[1]: Leaving directory `/home/jeff/pitivi-git/pitivi/help'
make: *** [all-recursive] Error 1
Comment 3 Javier Jardón (IRC: jjardon) 2012-12-11 04:37:00 UTC
Created attachment 231232 [details] [review]

Updated patch against current master.

Seems that Olivier remove some lines in needed for the build
Comment 4 Oliver Propst 2012-12-11 09:57:58 UTC
(In reply to comment #3)
> Created an attachment (id=231232) [details] [review]
> Use-yelp-tools-instead-gnome-doc-utils.v2
> Updated patch against current master.
> Seems that Olivier remove some lines in needed for the build

Thanks Javier for taking the time and "fixing" my mistake and update the patch. I'm sorry for not looking into this sooner, needless to say I'm no expert in build scripts. I should of course have tasted the patch more carefully before submitting it.
Comment 5 Jean-François Fortin Tam 2012-12-15 22:44:40 UTC
Review of attachment 231232 [details] [review]:

There's a few typos. One of the lines should probably like this instead:

>  echo "please install the yelp-tools package"

Also, is there a specific reason why you changed the ghelp:   uris to help:   ?
This seems to break loading the manual pages in yelp from pitivi and prevents me from pushing your patch.

Please ensure that your patch keeps working with ./ && make && make check (make distcheck will fail, but that's not related to your patch), and that you can open the user manual from inside the application in both the non-installed (dev) mode and the system-wide installed version.

Thanks :)
Comment 6 Jean-François Fortin Tam 2012-12-15 22:48:19 UTC
Oh, and if you want to know where the help URI is actually being used, it's at the bottom of utils/, in the "show_user_manual" method.
Comment 7 Jeremy Bicha 2013-07-20 04:14:11 UTC
(In reply to comment #5)
> Also, is there a specific reason why you changed the ghelp:   uris to help:   ?

help: is correct.
Comment 8 Jeremy Bicha 2013-07-21 03:36:34 UTC
*** Bug 704626 has been marked as a duplicate of this bug. ***
Comment 9 Lubosz Sarnecki 2013-07-26 18:18:33 UTC
yelp uses file:// urls for local files and help:app_id urls for installed help packages.

this command does not work:
yelp help:///home/bmonkey/workspace/ges/pitivi/help/C/

but this does:
yelp file:///home/bmonkey/workspace/ges/pitivi/help/C/

Pitivi uses Gtk.show_uri to open the file. The file url would open the directory in nautilus. When would be chosen, it would open either a web browser or a text editor, depending on which mime type was recognized and which application is associated with it. Yelp does not install a mime type for *.page files, could be something like x-mallard. So this won't work.

But this still works:

yelp ghelp:///home/bmonkey/workspace/ges/pitivi/help/C/

So keeping ghelp for local and taking help:pitivi for installed works.

I modified the patch and updated it for current master.
Comment 10 Jean-François Fortin Tam 2013-08-18 04:49:19 UTC
Alright, so I re-reviewed everything and applied some tiny fixes on top, pushed as commit 75b96b2 to master while preserving the original authorship (Olivier did the big part of the work after all).

Note: see bug #706223 for the followup on the help: vs ghelp: issue.

Everybody, thanks for your patience and help, and my apologies for taking so long to get around to merging and pushing this - many pressing things got in the way in the past few months. I hope to be quicker for your next patch :)
Comment 11 Jean-François Fortin Tam 2013-08-18 04:55:02 UTC
*** Bug 685058 has been marked as a duplicate of this bug. ***
Comment 12 Thibault Saunier 2013-08-24 07:31:29 UTC
Reopening as that patch broke $make distcheck, we are now getting:

make[3]: Entering directory `/home/thiblahute/devel/pitivi/1.0-uninstalled/pitivi/data/audiopresets'
make[3]: Leaving directory `/home/thiblahute/devel/pitivi/1.0-uninstalled/pitivi/data/audiopresets'
 (cd videopresets && make  top_distdir=../../pitivi-0.99.0 distdir=../../pitivi-0.99.0/data/videopresets \
     am__remove_distdir=: am__skip_length_check=: am__skip_mode_fix=: distdir)
make[3]: Entering directory `/home/thiblahute/devel/pitivi/1.0-uninstalled/pitivi/data/videopresets'
make[3]: Leaving directory `/home/thiblahute/devel/pitivi/1.0-uninstalled/pitivi/data/videopresets'
make[2]: Leaving directory `/home/thiblahute/devel/pitivi/1.0-uninstalled/pitivi/data'
 (cd help && make  top_distdir=../pitivi-0.99.0 distdir=../pitivi-0.99.0/help \
     am__remove_distdir=: am__skip_length_check=: am__skip_mode_fix=: distdir)
make[2]: Entering directory `/home/thiblahute/devel/pitivi/1.0-uninstalled/pitivi/help'
 cd .. && /bin/sh /home/thiblahute/devel/pitivi/1.0-uninstalled/pitivi/missing automake-1.13 --gnu help/Makefile warning: AM_INIT_AUTOMAKE: two- and three-arguments forms are deprecated.  For more info, see:
 cd .. && /bin/sh ./config.status help/Makefile 
config.status: creating help/Makefile
make[2]: Leaving directory `/home/thiblahute/devel/pitivi/1.0-uninstalled/pitivi/help'
make[2]: Entering directory `/home/thiblahute/devel/pitivi/1.0-uninstalled/pitivi/help'
cp: cannot stat ‘./cs/’: No such file or directory
[3]+  Stopped                 vimx -n help/
[ptv] thiblahute@Thibault-laptop ~/devel/pitivi/1.0-unins
Comment 13 Jean-François Fortin Tam 2013-08-30 01:25:33 UTC
Sigh :(
Would be awesome if someone here is willing to help with this, as this becomes a release blocker (we can't release if make distcheck fails).