* 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>
* Add the files to the distribution tarbal via EXTRA_DIST
* Build the module via the all-local target
* Add run-tox.sh to the tests run via make check
* Add manual page
Signed-off-by: Loic Dachary <ldachary@redhat.com>
* 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>
this change will enable us to specify `:orphan:` in the fieldlist of
a manpage rst file, otherwise sphinx-build complains at seeing it if
it is not referenced by a toc doc.
Signed-off-by: Kefu Chai <kchai@redhat.com>
sphinx requires that a document tree to be in a single directory,
and the man pages are references by our document. so a simple solution
would be to put all the rst file under a single directory.
Fixes: #11320
Signed-off-by: Kefu Chai <kchai@redhat.com>
sphinx complains:
SEVERE: Duplicated ID: "cmdoption-radosgw-admin--bucket"
at seeing duplicated `--bucket` option in radosgw-admin.rst. and
there is a global `--bucket` for all commands of radosgw, so remove
the one for the `quota` command.
Signed-off-by: Kefu Chai <kchai@redhat.com>
On RHEL 6 and CentOS 6 sphinx 1.0+ which is required to build man pages
is packaged as sphinx10 instead of sphinx and the binary is
sphinx-1.0-build instead of sphinx-build.
Signed-off-by: Loic Dachary <ldachary@redhat.com>
* 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>
merge-diff and status commands, --image-features and --image-shared
options, other stuff.
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
(cherry picked from commit 356a749f63)
undersized not valid: undersized not in inactive|unclean|stale
undersized not valid: undersized doesn't represent an int
Invalid command: unused arguments: ['undersized']
pg dump_stuck {inactive|unclean|stale [inactive|unclean|stale...]} {<int>} : show information about stuck pgs
Signed-off-by: xinxin shu <xinxin.shu@intel.com>
