[PATCH 5/4] doc: use a dynamic list of man pages

Kristian Høgsberg hoegsberg at gmail.com
Wed Apr 3 12:49:34 PDT 2013


On Wed, Apr 03, 2013 at 03:34:45PM +1000, Peter Hutterer wrote:
> This requires that doxygen is run before the man target so find can actually
> find the man pages.
> 
> Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
> ---
> On Wed, Apr 03, 2013 at 04:54:10AM +0100, Daniel Stone wrote:
> > Is there any chance we
> > can generate the list of manpages (e.g. by shelling out to doxygen)
> > rather than having a static list though?
> 
> Something like this?
> 
> I suspect we really only want to ship wl_foo.3 man pages anyway, I'm sure
> overwriting e.g. accept(3) is a no-no :)
> 
> Patch goes on top of the other 4, but can be squashed in if needed.

Looks a little magic, but I think it's fine.  It depends on 7, 8 and
2, 3 from the previous series, so I'll wait for a respin of those.

Thanks,
Kristian

>  doc/doxygen/Makefile.am | 56 +++++--------------------------------------------
>  1 file changed, 5 insertions(+), 51 deletions(-)
> 
> diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am
> index e41c790..c98c473 100644
> --- a/doc/doxygen/Makefile.am
> +++ b/doc/doxygen/Makefile.am
> @@ -10,56 +10,7 @@ scanned_src_files_server = 				\
>  	$(top_srcdir)/src/wayland-server.c	\
>  	$(top_srcdir)/src/wayland-server.h
>  
> -client_MANPAGES = \
> -	man/man3/wl_display.3 \
> -	man/man3/wl_display_connect.3 \
> -	man/man3/wl_display_connect_to_fd.3 \
> -	man/man3/wl_display_create_queue.3 \
> -	man/man3/wl_display_disconnect.3 \
> -	man/man3/wl_display_dispatch.3 \
> -	man/man3/wl_display_dispatch_pending.3 \
> -	man/man3/wl_display_dispatch_queue.3 \
> -	man/man3/wl_display_dispatch_queue_pending.3 \
> -	man/man3/wl_display_flush.3 \
> -	man/man3/wl_display_get_error.3 \
> -	man/man3/wl_display_get_fd.3 \
> -	man/man3/wl_display_roundtrip.3 \
> -	man/man3/wl_event_queue.3 \
> -	man/man3/wl_event_queue_destroy.3 \
> -	man/man3/wl_proxy.3 \
> -	man/man3/wl_proxy_add_listener.3 \
> -	man/man3/wl_proxy_create.3 \
> -	man/man3/wl_proxy_destroy.3 \
> -	man/man3/wl_proxy_get_class.3 \
> -	man/man3/wl_proxy_get_id.3 \
> -	man/man3/wl_proxy_get_user_data.3 \
> -	man/man3/wl_proxy_marshal.3 \
> -	man/man3/wl_proxy_set_queue.3 \
> -	man/man3/wl_proxy_set_user_data.3
> -
> -server_MANPAGES = \
> -	man/man3/wl_buffer.3 \
> -	man/man3/wl_client.3 \
> -	man/man3/wl_data_offer.3 \
> -	man/man3/wl_data_source.3 \
> -	man/man3/wl_global.3 \
> -	man/man3/wl_keyboard.3 \
> -	man/man3/wl_keyboard_grab.3 \
> -	man/man3/wl_keyboard_grab_interface.3 \
> -	man/man3/wl_listener.3 \
> -	man/man3/wl_pointer.3 \
> -	man/man3/wl_pointer_grab.3 \
> -	man/man3/wl_pointer_grab_interface.3 \
> -	man/man3/wl_resource.3 \
> -	man/man3/wl_seat.3 \
> -	man/man3/wl_signal.3 \
> -	man/man3/wl_socket.3 \
> -	man/man3/wl_surface.3 \
> -	man/man3/wl_touch.3 \
> -	man/man3/wl_touch_grab.3 \
> -	man/man3/wl_touch_grab_interface.3
> -
> -man3_MANS= $(client_MANPAGES) $(server_MANPAGES)
> +man3_MANS= $(shell find man/man3/ -name "wl_*.3" -printf "man/man3/%P\n")
>  
>  xml/client/index.xml: $(scanned_src_files_client) wayland.doxygen
>  	$(AM_V_GEN)$(MKDIR_P) xml/client
> @@ -84,8 +35,11 @@ doxygen.man: $(scanned_src_files_client) $(scanned_src_files_server)
>            echo "INPUT= $^"; \
>            ) | doxygen -
>  
> -$(client_MANPAGES) $(server_MANPAGES): doxygen.man
> +# there is no man-local
> +all-local: doxygen.man
>  
>  clean-local:
>  	rm -rf xml/
>  	rm -rf man/
> +
> +EXTRA_DIST = $(man3_MANS)
> -- 
> 1.8.1.4
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel


More information about the wayland-devel mailing list