From 6eeecb8585aed84759f968efb315e97db0cc8e52 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Tue, 1 Nov 2016 11:59:59 +0000 Subject: gtkdochelper: Add 'overrides.txt' to the content files MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit If a `-overrides.txt` file exists in the docs directory it means it's intended to be used in place of the one gtk-doc generates. GLib and GTK+, for instance, ship with one because some of the types they provide — like the thread primitives, or the platform macros — contain architecture-dependent fields that should not be accessed directly. This commit should close the last bit of issue #550. --- mesonbuild/scripts/gtkdochelper.py | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'mesonbuild/scripts') diff --git a/mesonbuild/scripts/gtkdochelper.py b/mesonbuild/scripts/gtkdochelper.py index 53b1c32..4f8a9a5 100755 --- a/mesonbuild/scripts/gtkdochelper.py +++ b/mesonbuild/scripts/gtkdochelper.py @@ -69,6 +69,10 @@ def build_gtkdoc(source_root, build_root, doc_subdir, src_subdir, if os.path.exists(sections): content_files.append(sections) + overrides = os.path.join(doc_src, module + "-overrides.txt") + if os.path.exists(overrides): + content_files.append(overrides) + # Copy files to build directory for f in content_files: f_abs = os.path.join(doc_src, f) -- cgit v1.1 From e226d702bc0ae0dbe15872a54e0743b197b37851 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Tue, 1 Nov 2016 12:13:36 +0000 Subject: gtkdoc: Add `ignore_headers` positional argument Not all headers are public, or contain public types. GTK-Doc allows adding headers to be ignored during the "scan" phase, by passing the `--ignore-headers` command line argument to gtkdoc-scan. Currently, you can do something like: ignored_headers = [ 'foo-private.h', 'bar-private.h', ] gnome.gtkdoc(... scan_args: [ '--ignore-headers=' + ' '.join(ignored_headers), ], ...) But it does not guarantee escaping rules and it's definitely not nice. We can add a simpler version of that mechanism through a new positional argument, `ignore_headers`, which behaves like `content_files` or `html_assets`, and takes an array of header files to ignore: gnome.gtkdoc(... ignore_headers: ignored_headers, ...) --- mesonbuild/scripts/gtkdochelper.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'mesonbuild/scripts') diff --git a/mesonbuild/scripts/gtkdochelper.py b/mesonbuild/scripts/gtkdochelper.py index 4f8a9a5..220801d 100755 --- a/mesonbuild/scripts/gtkdochelper.py +++ b/mesonbuild/scripts/gtkdochelper.py @@ -39,6 +39,7 @@ parser.add_argument('--ldflags', dest='ldflags', default='') parser.add_argument('--cflags', dest='cflags', default='') parser.add_argument('--content-files', dest='content_files', default='') parser.add_argument('--html-assets', dest='html_assets', default='') +parser.add_argument('--ignore-headers', dest='ignore_headers', default='') parser.add_argument('--installdir', dest='install_dir') def gtkdoc_run_check(cmd, cwd): @@ -56,7 +57,7 @@ def gtkdoc_run_check(cmd, cwd): def build_gtkdoc(source_root, build_root, doc_subdir, src_subdir, main_file, module, html_args, scan_args, fixxref_args, gobject_typesfile, scanobjs_args, ld, cc, ldflags, cflags, - html_assets, content_files): + html_assets, content_files, ignore_headers): print("Building documentation for %s" % module) abs_src = os.path.join(source_root, src_subdir) @@ -91,7 +92,8 @@ def build_gtkdoc(source_root, build_root, doc_subdir, src_subdir, scan_cmd = ['gtkdoc-scan', '--module=' + module, - '--source-dir=' + abs_src] + scan_args + '--source-dir=' + abs_src, + '--ignore-headers=' + ignore_headers] + scan_args gtkdoc_run_check(scan_cmd, abs_out) if gobject_typesfile: @@ -176,7 +178,8 @@ def run(args): options.ldflags, options.cflags, options.html_assets.split('@@') if options.html_assets else [], - options.content_files.split('@@') if options.content_files else []) + options.content_files.split('@@') if options.content_files else [], + options.ignore_headers.split('@@') if options.ignore_headers else []) if 'MESON_INSTALL_PREFIX' in os.environ: install_dir = options.install_dir if options.install_dir else options.modulename -- cgit v1.1