RepoMirrors
/
ceph
mirror of https://github.com/ceph/ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ceph/man/Makefile.am

32 lines
654 B
Makefile
Raw Normal View History

man: mkcephfs, cosd man pages
2009-03-10 21:39:54 +00:00
AUTOMAKE_OPTIONS = gnu
man: add conf.py to the list of distributed files Otherwise packages won't build as it's not included in the tarbal. Signed-off-by: Loic Dachary <ldachary@redhat.com>
2015-04-02 22:22:01 +00:00
EXTRA_DIST = conf.py
Split Makefile.am in man
2015-01-15 09:17:34 +00:00
dist_man_MANS =
configure.ac: add an option: --with-man-pages * do not require sphinx-build if --without-man-pages * dist rst files for man pages * build and dist .8 files if sphinx-build is found Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-05-04 16:26:31 +00:00
if WITH_MAN_PAGES
man: move ENABLE_* to Makefile.am
2015-03-05 18:35:02 +00:00
if ENABLE_CLIENT
include Makefile-client.am
endif
if ENABLE_SERVER
include Makefile-server.am
endif
doc: generate man pages in man/Makefile * move rst files from doc/man/8 into man/8 * extract man_pages setting for sphinx from doc/conf.py to man/conf.py * generate all man pages in `make install` * add python-sphinx to Build-Depends * check for sphinx-build in `configure` * run changed rst files through sphinx-build in `make check` Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-03-23 06:08:16 +00:00
# prevent `make` from running in parallel, sphinx runs better in batch mode.
.PHONY: sphinx-build.stamp
$(dist_man_MANS): sphinx-build.stamp
man: enable warning msgs for "all" target * and remove `local-check` target. because we have killed all warnings, and `make check` depends on `am-all` actually. so previously, `make check` basically does nothing at all for validating the man pages' syntax. `make all` has rendered them already. * do not run sphinx-build if $(top_srcdir)/doc/man does not exist. this is exactly the case of `make install` from a dist tarball. * remove generated man pages in `make maintainer-clean` not in `make clean`, because we don't ship .rst files in the dist tarball. Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 10:29:35 +00:00
# in a tree populated from dist tarball, the $(top_srcdir)/doc is not included
doc: generate man pages in man/Makefile * move rst files from doc/man/8 into man/8 * extract man_pages setting for sphinx from doc/conf.py to man/conf.py * generate all man pages in `make install` * add python-sphinx to Build-Depends * check for sphinx-build in `configure` * run changed rst files through sphinx-build in `make check` Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-03-23 06:08:16 +00:00
sphinx-build.stamp:
man: enable warning msgs for "all" target * and remove `local-check` target. because we have killed all warnings, and `make check` depends on `am-all` actually. so previously, `make check` basically does nothing at all for validating the man pages' syntax. `make all` has rendered them already. * do not run sphinx-build if $(top_srcdir)/doc/man does not exist. this is exactly the case of `make install` from a dist tarball. * remove generated man pages in `make maintainer-clean` not in `make clean`, because we don't ship .rst files in the dist tarball. Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 10:29:35 +00:00
if [ -d $(top_srcdir)/doc/man ] ; then \
automake: Fix out-of-tree build. Corrects minor Automake errors which prevented Ceph from building when configure was invoked from a different directory than the toplevel source directory. Signed-off-by: Krzysztof Kosiński <krzysztof.kosinski@intel.com>
2015-07-15 12:44:42 +00:00
${SPHINX_BUILD} -b man -d doctrees -c $(top_srcdir)/man $(top_srcdir)/doc/man $(top_builddir)/man; \
man: enable warning msgs for "all" target * and remove `local-check` target. because we have killed all warnings, and `make check` depends on `am-all` actually. so previously, `make check` basically does nothing at all for validating the man pages' syntax. `make all` has rendered them already. * do not run sphinx-build if $(top_srcdir)/doc/man does not exist. this is exactly the case of `make install` from a dist tarball. * remove generated man pages in `make maintainer-clean` not in `make clean`, because we don't ship .rst files in the dist tarball. Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 10:29:35 +00:00
fi
doc: generate man pages in man/Makefile * move rst files from doc/man/8 into man/8 * extract man_pages setting for sphinx from doc/conf.py to man/conf.py * generate all man pages in `make install` * add python-sphinx to Build-Depends * check for sphinx-build in `configure` * run changed rst files through sphinx-build in `make check` Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-03-23 06:08:16 +00:00
clean-local:
@rm -rf doctrees
man: enable warning msgs for "all" target * and remove `local-check` target. because we have killed all warnings, and `make check` depends on `am-all` actually. so previously, `make check` basically does nothing at all for validating the man pages' syntax. `make all` has rendered them already. * do not run sphinx-build if $(top_srcdir)/doc/man does not exist. this is exactly the case of `make install` from a dist tarball. * remove generated man pages in `make maintainer-clean` not in `make clean`, because we don't ship .rst files in the dist tarball. Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 10:29:35 +00:00
MAINTAINERCLEANFILES = $(dist_man_MANS)
man: do not dist man pages if sphinx is not available Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-05-04 17:57:17 +00:00
endif