diff options
| author | Nirbheek Chauhan <nirbheek@centricular.com> | 2017-07-17 12:40:09 +0530 |
|---|---|---|
| committer | Nirbheek Chauhan <nirbheek@centricular.com> | 2017-07-17 12:40:41 +0530 |
| commit | 04ac7a48447b884544d160ebee824ad571408c79 (patch) | |
| tree | d3e0ce56e6b8a56e6cacf1ce2458a6b56dc66e1b /docs/markdown | |
| parent | f77c3176ab5cb583fc32bfdebeb320481b7d3592 (diff) | |
| download | meson-04ac7a48447b884544d160ebee824ad571408c79.zip meson-04ac7a48447b884544d160ebee824ad571408c79.tar.gz meson-04ac7a48447b884544d160ebee824ad571408c79.tar.bz2 | |
gnome.gtkdoc: Handle absolute install_dirs correctly
Must prepend DESTDIR in case it's absolute. Also document that by
default it is relative to the gtk-doc html directory.
Diffstat (limited to 'docs/markdown')
| -rw-r--r-- | docs/markdown/Gnome-module.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/markdown/Gnome-module.md b/docs/markdown/Gnome-module.md index e709fd5..d01deaf 100644 --- a/docs/markdown/Gnome-module.md +++ b/docs/markdown/Gnome-module.md @@ -136,14 +136,14 @@ Note that very old versions of yelp may not support symlinked media; At least 3. ### gnome.gtkdoc() -Compiles and installs gtkdoc documentation. Takes one positional arguments; The name of the module. +Compiles and installs gtkdoc documentation into `prefix/share/gtk-doc/html`. Takes one positional argument: The name of the module. * `main_xml`: specifies the main XML file * `main_sgml`: equal to `main_xml` * `src_dir`: include_directories to include * `dependencies`: a list of dependencies * `install`: if true, installs the generated docs -* `install_dir`: the directory to install the generated docs +* `install_dir`: the directory to install the generated docs relative to the gtk-doc html dir or an absolute path (default: module name) * `scan_args`: a list of arguments to pass to `gtkdoc-scan` * `scanobjs_args`: a list of arguments to pass to `gtkdoc-scangobj` * `gobject_typesfile`: a list of type files |