man/meson.build

   1 # Copyright © 2018 Intel Corporation
   2 #
   3 # All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions are met:
   7 #
   8 # - Redistributions of source code must retain the above copyright notice, this
   9 #   list of conditions and the following disclaimer.
  10 #
  11 # - Redistributions in binary form must reproduce the above copyright notice,
  12 #   this list of conditions and the following disclaimer in the documentation
  13 #   and/or other materials provided with the distribution.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  16 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18 # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  19 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21 # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  23 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25
  26 files_man_common = files(
  27   'common/author-chad.versace.xml',
  28   'common/author-emil.velikov.xml',
  29   'common/author-jordan.l.justen.xml',
  30   'common/copyright.xml',
  31   'common/error-codes.xml',
  32   'common/issues.xml',
  33   'common/legalnotice.xml',
  34   'common/return-value.xml',
  35 )
  36
  37 # Each entry is a 4 part tuple consisting of
  38 # <man section>, <name>, <extra pages that are <name>_<page>>, <extra_pages>
  39 man_targets = [
  40   ['1', 'wflinfo', [], []],
  41   ['3', 'waffle_attrib_list', ['get', 'get_with_default', 'length', 'update'], []],
  42   ['3', 'waffle_config', ['choose', 'destroy', 'get_native'], []],
  43   ['3', 'waffle_context', ['create', 'destroy', 'get_native'], []],
  44   ['3', 'waffle_display', ['connect', 'disconnect', 'get_native', 'supports_context_api'], []],
  45   ['3', 'waffle_dl', ['can_open', 'sym'], []],
  46   ['3', 'waffle_enum', ['to_string'], []],
  47   ['3', 'waffle_error', ['get_code', 'get_info', 'to_string'], []],
  48   ['3', 'waffle_gbm', ['config', 'context', 'display', 'window'], []],
  49   ['3', 'waffle_get_proc_address', [], []],
  50   ['3', 'waffle_glx', ['config', 'context', 'display', 'window'], []],
  51   ['3', 'waffle_init', [], []],
  52   ['3', 'waffle_is_extension_in_string', [], []],
  53   ['3', 'waffle_make_current', [], ['waffle_get_current_display', 'waffle_get_current_window', 'waffle_get_current_context']],
  54   ['3', 'waffle_native', ['config', 'context', 'display', 'window'], []],
  55   ['3', 'waffle_teardown', [], []],
  56   ['3', 'waffle_wayland', ['config', 'context', 'display', 'window'], []],
  57   ['3', 'waffle_window', ['create', 'destroy', 'get_native', 'show', 'swap_buffers'], []],
  58   ['3', 'waffle_x11_egl', ['config', 'context', 'display', 'window'], []],
  59   ['7', 'waffle', [], []],
  60   ['7', 'waffle_feature_test_macros', [], []],
  61 ]
  62
  63
  64 if get_option('build-manpages')
  65   prog_xslt = find_program('xsltproc')
  66   mans = []
  67
  68   foreach s : man_targets
  69     extra_out = []
  70     foreach e : s[2]
  71       extra_out += '@0@_@1@.@2@'.format(s[1], e, s[0])
  72     endforeach
  73     foreach e : s[3]
  74       extra_out += '@0@.@1@'.format(e, s[0])
  75     endforeach
  76
  77     name = '@0@.@1@'.format(s[1], s[0])
  78
  79     mans += custom_target(
  80       name,
  81       input : ['manpage.xsl', name + '.xml'],
  82       output : [name, extra_out],
  83       command : [prog_xslt, '-nonet', '--xinclude', '-o', '@OUTPUT0@', '@INPUT@'],
  84       install : true,
  85       install_dir : join_paths(get_option('mandir'), 'man' + s[0]),
  86       depend_files : files_man_common,
  87     )
  88   endforeach
  89 endif
  90
  91 if get_option('build-htmldocs')
  92   prog_xslt = find_program('xsltproc')
  93
  94   foreach s : man_targets
  95     extra_out = []
  96     foreach e : s[2]
  97       extra_out += '@0@_@1@.@2@'.format(s[1], e, s[0])
  98     endforeach
  99     foreach e : s[3]
 100       extra_out += '@0@.@1@'.format(e, s[0])
 101     endforeach
 102
 103     name = '@0@.@1@'.format(s[1], s[0])
 104
 105     custom_target(
 106       name + '.html',
 107       input : ['html.xsl', name + '.xml'],
 108       output : [name + '.html'],
 109       command : [prog_xslt, '-nonet', '--xinclude', '-o', '@OUTPUT0@', '@INPUT@'],
 110       install : true,
 111       install_dir : join_paths(docdir, 'html', 'man'),
 112       depend_files : files_man_common,
 113     )
 114   endforeach
 115 endif