Bug 82448 – [GTK] generate-gtk-doc doesn't cope with custom build directory

• Status: RESOLVED
• Resolution: FIXED
• Component: Tools / Tests

[Philippe Normand]

I have one product directory per branch. So generate-gtk-doc should use WebKitBuild/brancName/Release or Debug instead of trying almost random directories in WebKitBuild :)

[Philippe Normand]

Created attachment 134263 [details]
Patch

[Philippe Normand]

Carlos can you please test this patch in the distcheck scenario?

[Martin Robinson]

Comment on attachment 134263 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=134263&action=review

> Tools/gtk/generate-gtkdoc:-123
> +    build_directory = sys.argv[-1]
>      options = get_common_options().copy()
>      options.update({
>          'module_name' : 'webkitgtk',
>          'doc_dir' : src_path('docs'),
> -        'output_dir' : common.build_path('Documentation', 'webkitgtk'),

This looks like it will pass something crazy (like the command name) if you don't pass an argument for build directory. I think I'd like to keep the logic for understanding the command-line arguments in common.build_path instead of forcing all the code here to pass the build_directory down. 

in common.get_build_path() you could do this:

def get_build_path():
    if len(sys.argv) > 1 and os.path.exists(sys.argv[-1]):
        # Try to use this path as a build directory.

With that change you could avoid all the modifications to this file.

[Philippe Normand]

Created attachment 134299 [details]
Patch

[Martin Robinson]

Comment on attachment 134299 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=134299&action=review

> Tools/gtk/common.py:-40
> -    global build_dir
> -    if build_dir:
> -        return build_dir

Why do you no longer cache the build directory here?

[Martin Robinson]

Comment on attachment 134299 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=134299&action=review

>> Tools/gtk/common.py:-40
>> -        return build_dir
> 
> Why do you no longer cache the build directory here?

I cannot see a reason why it isn't. The patch looks great, but I think caching the build directory was a nice feature in that it avoided touching the file system every time you needed the build directory. Perhaps you could restore that before landing?

[Philippe Normand]

(In reply to comment #5)
> (From update of attachment 134299 [details])
> View in context: https://bugs.webkit.org/attachment.cgi?id=134299&action=review
> 
> > Tools/gtk/common.py:-40
> > -    global build_dir
> > -    if build_dir:
> > -        return build_dir
> 
> Why do you no longer cache the build directory here?

Right, I'll restore this part and land, thanks for the review :)

[Philippe Normand]

Committed r112408: <http://trac.webkit.org/changeset/112408>