From 7d3d2ae31053b741b7dd30918e023c364413c25a Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Thu, 16 Apr 2020 19:50:52 +0200 Subject: [PATCH] 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 Closes: https://gitlab.freedesktop.org/wayland/wayland/-/issues/156 --- Makefile.am | 1 - configure.ac | 1 - doc/Makefile.am | 2 +- doc/man/Makefile.am | 49 --------------- doc/man/meson.build | 46 -------------- doc/man/wl_display_connect.xml | 112 --------------------------------- doc/meson.build | 1 - 7 files changed, 1 insertion(+), 211 deletions(-) delete mode 100644 doc/man/Makefile.am delete mode 100644 doc/man/meson.build delete mode 100644 doc/man/wl_display_connect.xml diff --git a/Makefile.am b/Makefile.am index cc87392..b9438b7 100644 --- a/Makefile.am +++ b/Makefile.am @@ -327,7 +327,6 @@ EXTRA_DIST += tests/scanner-test.sh \ doc/doxygen/xml/meson.build \ doc/doxygen/xml/Client/meson.build \ doc/doxygen/xml/Server/meson.build \ - doc/man/meson.build \ doc/publican/meson.build \ doc/publican/sources/meson.build \ egl/meson.build \ diff --git a/configure.ac b/configure.ac index fe03539..ace83b2 100644 --- a/configure.ac +++ b/configure.ac @@ -190,7 +190,6 @@ AC_CONFIG_FILES([Makefile doc/Makefile doc/publican/Makefile doc/doxygen/Makefile - doc/man/Makefile egl/wayland-egl.pc egl/wayland-egl-backend.pc src/wayland-server-uninstalled.pc 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 @@ - - - - - - - - wl_display_connect - wayland-client - September 2012 - - - Developer - David - Herrmann - dh.herrmann@googlemail.com - - - - - - wl_display_connect - 3 - - - - wl_display_connect - wl_display_connect_to_fd - Connect to a Wayland socket - - - - - - #include <wayland-client.h> - - - struct wl_display *wl_display_connect - const char *name - - - - struct wl_display *wl_display_connect_to_fd - int fd - - - - - - - Description - wl_display_connect connects to a Wayland socket - that was previously opened by a Wayland server. The server socket must - be placed in XDG_RUNTIME_DIR when WAYLAND_DISPLAY - (or name, 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. - - The name argument specifies the name of - the socket or NULL to use the default (which is - "wayland-0"). The environment variable - WAYLAND_DISPLAY replaces the default value. - - If name 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 WAYLAND_DISPLAY to an absolute - path will implicitly cause name to take on that - absolute path if name is NULL. - - If WAYLAND_SOCKET is set, this function behaves like - wl_display_connect_to_fd with the file-descriptor - number taken from the environment variable. - - Support for interpreting WAYLAND_DISPLAY as an - absolute path is a change in behavior compared to - wl_display_connect'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 - XDG_RUNTIME_DIR and WAYLAND_DISPLAY. - Manual construction of the socket path must account for the - possibility that WAYLAND_DISPLAY contains an absolute - path. - - wl_display_connect_to_fd connects to a Wayland - socket with an explicit file-descriptor. The file-descriptor is passed - as argument fd. - - - - Return Value - wl_display_connect and - wl_display_connect_to_fd return a new display - context object or NULL on failure. errno is set - correspondingly. - - - - See Also - - wayland-client7, - wl_display_disconnect3, - wl_display_iterate3 - - - 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')