diff options
| author | Simon Ser <contact@emersion.fr> | 2020-04-16 19:50:52 +0200 |
|---|---|---|
| committer | Simon Ser <contact@emersion.fr> | 2020-04-16 19:53:28 +0200 |
| commit | 7d3d2ae31053b741b7dd30918e023c364413c25a (patch) | |
| tree | 200c5f2f84444f80ad79ea88cf6c2d16eb5a4791 /doc | |
| parent | client: improve wl_display_connect docs (diff) | |
| download | wayland-7d3d2ae31053b741b7dd30918e023c364413c25a.tar wayland-7d3d2ae31053b741b7dd30918e023c364413c25a.tar.gz wayland-7d3d2ae31053b741b7dd30918e023c364413c25a.tar.bz2 wayland-7d3d2ae31053b741b7dd30918e023c364413c25a.tar.lz wayland-7d3d2ae31053b741b7dd30918e023c364413c25a.tar.xz wayland-7d3d2ae31053b741b7dd30918e023c364413c25a.tar.zst wayland-7d3d2ae31053b741b7dd30918e023c364413c25a.zip | |
doc/man: remove manually written man pages
There is only one page written. Having manually-written man pages duplicates
information with doc comments. Besides, man pages are already generated by
Doxygen.
Signed-off-by: Simon Ser <contact@emersion.fr>
Closes: https://gitlab.freedesktop.org/wayland/wayland/-/issues/156
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/man/Makefile.am | 49 | ||||
| -rw-r--r-- | doc/man/meson.build | 46 | ||||
| -rw-r--r-- | doc/man/wl_display_connect.xml | 112 | ||||
| -rw-r--r-- | doc/meson.build | 1 |
5 files changed, 1 insertions, 209 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 1efd3e2..0b1c4f2 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1 +1 @@ -SUBDIRS = doxygen publican man +SUBDIRS = doxygen publican diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am deleted file mode 100644 index 4e6365c..0000000 --- a/doc/man/Makefile.am +++ /dev/null @@ -1,49 +0,0 @@ -# -# This generates man-pages out of the Docbook XML files. Simply add your files -# to the $MANPAGES array. If aliases are created, please add them to the -# MANPAGES_ALIASES array so they get installed correctly. -# - -MANPAGES = \ - wl_display_connect.3 -MANPAGES_ALIASES = \ - wl_display_connect_to_fd.3 - -XML_FILES = \ - ${patsubst %.1,%.xml,${patsubst %.3,%.xml,${patsubst %.5,%.xml,${patsubst %.7,%.xml,$(MANPAGES)}}}} -CLEANFILES = -EXTRA_DIST = $(XML_FILES) - -if HAVE_XSLTPROC - -CLEANFILES += $(MANPAGES) $(MANPAGES_ALIASES) -EXTRA_DIST += $(MANPAGES) $(MANPAGES_ALIASES) -dist_man_MANS = $(MANPAGES) $(MANPAGES_ALIASES) - -XSLTPROC_FLAGS = \ - --stringparam man.authors.section.enabled 0 \ - --stringparam man.copyright.section.enabled 0 \ - --stringparam funcsynopsis.style ansi \ - --stringparam man.output.quietly 1 \ - --nonet - -XSLTPROC_PROCESS_MAN = \ - $(AM_V_GEN)$(MKDIR_P) $(dir $@) && \ - $(XSLTPROC) -o $@ $(XSLTPROC_FLAGS) $(DOCS_STYLESHEET) $< && \ - $(SED) -i -e 's/^\.so \(.*\)\.\(.\)$$/\.so man\2\/\1\.\2/' $(MANPAGES_ALIASES) - -%.1: %.xml - $(XSLTPROC_PROCESS_MAN) - -%.3: %.xml - $(XSLTPROC_PROCESS_MAN) - -%.5: %.xml - $(XSLTPROC_PROCESS_MAN) - -%.7: %.xml - $(XSLTPROC_PROCESS_MAN) - -wl_display_connect_to_fd.3: wl_display_connect.3 - -endif # HAVE_XSLTPROC diff --git a/doc/man/meson.build b/doc/man/meson.build deleted file mode 100644 index 0fd4cec..0000000 --- a/doc/man/meson.build +++ /dev/null @@ -1,46 +0,0 @@ -man_pages = [ - { - 'section': '3', - 'xml': 'wl_display_connect.xml', - 'name': 'wl_display_connect', - 'alias': 'wl_display_connect_to_fd', - } -] - -xsltproc_opts = [ - '--nonet', - '--stringparam', 'man.authors.section.enabled', '0', - '--stringparam', 'man.copyright.section.enabled', '0', - '--stringparam', 'funcsynopsis.style', 'ansi', - '--stringparam', 'man.output.quietly', '1', -] - -foreach page: man_pages - section_number = page['section'] - xml_input = page['xml'] - name = page['name'] - alias = page.get('alias', '') - - man_output = name + '.' + section_number - if alias != '' - alias_output = alias + '.' + section_number - else - alias_output = [] - endif - - man_page = custom_target( - name + '-man', - command: [ - xsltproc, - xsltproc_opts, - '-o', '@OUTPUT0@', - manpage_xsl, - '@INPUT@', - ], - input: xml_input, - output: [ man_output, alias_output ], - install: true, - install_dir: join_paths(get_option('prefix'), get_option('mandir'), 'man' + section_number), - build_by_default: true, - ) -endforeach diff --git a/doc/man/wl_display_connect.xml b/doc/man/wl_display_connect.xml deleted file mode 100644 index dab4ddb..0000000 --- a/doc/man/wl_display_connect.xml +++ /dev/null @@ -1,112 +0,0 @@ -<?xml version='1.0'?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - -<!-- - Written 2012 by David Herrmann <dh.herrmann@googlemail.com> - Dedicated to the Public Domain ---> - -<refentry id="wl_display_connect"> - <refentryinfo> - <title>wl_display_connect</title> - <productname>wayland-client</productname> - <date>September 2012</date> - <authorgroup> - <author> - <contrib>Developer</contrib> - <firstname>David</firstname> - <surname>Herrmann</surname> - <email>dh.herrmann@googlemail.com</email> - </author> - </authorgroup> - </refentryinfo> - - <refmeta> - <refentrytitle>wl_display_connect</refentrytitle> - <manvolnum>3</manvolnum> - </refmeta> - - <refnamediv> - <refname>wl_display_connect</refname> - <refname>wl_display_connect_to_fd</refname> - <refpurpose>Connect to a Wayland socket</refpurpose> - </refnamediv> - - <refsynopsisdiv> - <funcsynopsis> - - <funcsynopsisinfo>#include <wayland-client.h></funcsynopsisinfo> - - <funcprototype> - <funcdef>struct wl_display *<function>wl_display_connect</function></funcdef> - <paramdef>const char *<parameter>name</parameter></paramdef> - </funcprototype> - - <funcprototype> - <funcdef>struct wl_display *<function>wl_display_connect_to_fd</function></funcdef> - <paramdef>int <parameter>fd</parameter></paramdef> - </funcprototype> - - </funcsynopsis> - </refsynopsisdiv> - - <refsect1> - <title>Description</title> - <para><function>wl_display_connect</function> connects to a Wayland socket - that was previously opened by a Wayland server. The server socket must - be placed in <envar>XDG_RUNTIME_DIR</envar> when <envar>WAYLAND_DISPLAY</envar> - (or <varname>name</varname>, see below) is a simple name, for this - function to find it. The server socket is also allowed to exist at an - arbitrary path; usage details follow. See below for compatibility issue - details.</para> - - <para>The <varname>name</varname> argument specifies the name of - the socket or <constant>NULL</constant> to use the default (which is - <constant>"wayland-0"</constant>). The environment variable - <envar>WAYLAND_DISPLAY</envar> replaces the default value. - - If <varname>name</varname> is an absolute path, then that path is used - as the Wayland socket to which the connection is attempted. Note that - in combination with the default-value behavior described above, this - implies that setting <envar>WAYLAND_DISPLAY</envar> to an absolute - path will implicitly cause <varname>name</varname> to take on that - absolute path if <varname>name</varname> is <constant>NULL</constant>. - - If <envar>WAYLAND_SOCKET</envar> is set, this function behaves like - <function>wl_display_connect_to_fd</function> with the file-descriptor - number taken from the environment variable.</para> - - <para>Support for interpreting <envar>WAYLAND_DISPLAY</envar> as an - absolute path is a change in behavior compared to - <function>wl_display_connect</function>'s behavior in versions - 1.14 and older of Wayland. It is no longer guaranteed in versions - 1.15 and higher that the Wayland socket chosen is equivalent to - manually constructing a socket pathname by concatenating - <envar>XDG_RUNTIME_DIR</envar> and <envar>WAYLAND_DISPLAY</envar>. - Manual construction of the socket path must account for the - possibility that <envar>WAYLAND_DISPLAY</envar> contains an absolute - path.</para> - - <para><function>wl_display_connect_to_fd</function> connects to a Wayland - socket with an explicit file-descriptor. The file-descriptor is passed - as argument <varname>fd</varname>.</para> - </refsect1> - - <refsect1> - <title>Return Value</title> - <para><function>wl_display_connect</function> and - <function>wl_display_connect_to_fd</function> return a new display - context object or NULL on failure. <varname>errno</varname> is set - correspondingly.</para> - </refsect1> - - <refsect1> - <title>See Also</title> - <para> - <citerefentry><refentrytitle>wayland-client</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>wl_display_disconnect</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>wl_display_iterate</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> - </refsect1> -</refentry> diff --git a/doc/meson.build b/doc/meson.build index 0b46f48..f74b6b1 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -34,5 +34,4 @@ publican_install_prefix = join_paths( publican_html_dir = 'html' subdir('doxygen') -subdir('man') subdir('publican') |
