Commit Graph

236 Commits

Author SHA1 Message Date
Kefu Chai
3b551e6db2 cmake: conditionally install man pages
this matches its counterpart in automake
* install fuse related man pages only if HAVE_LIBFUSE
* install rbd related man pages only if WITH_RBD

Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-03-26 00:03:19 +08:00
Kefu Chai
1287846c66 autotools: add rbdmap to dist_man_MANS
this fixes the rpm/deb build failure
was introduced by 20c8650

Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-03-25 23:53:52 +08:00
Boris Ranto
bcf12049fb selinux: Allow log files to be located in /var/log/radosgw
We do suggest users to put their logs in /var/log/radosgw in the
documentation at times. We should also label that directory with
ceph_var_log_t so that ceph daemons can also write there.

The commit also updates the man page for this policy. This man page is
automatically generated by

* sepolicy manpage -p . -d ceph_t

and have not been reloaded in a while. Hence, it contains few more
changes than the new radosgw directory.

Signed-off-by: Boris Ranto <branto@redhat.com>
2016-02-11 12:37:51 +01:00
Josh Durgin
b35061a7e6 man: stub manpage for rbd-mirror
Signed-off-by: Josh Durgin <jdurgin@redhat.com>
2016-02-04 00:10:16 -08:00
Yunchuan Wen
5ac1cbf979 add rbd-nbd doc
Signed-off-by: Yunchuan Wen <yunchuan.wen@kylin-cloud.com>
2015-11-21 23:26:44 +08:00
Boris Ranto
bc48ef0fef selinux: Fix man page location
The SELinux man page was previously located in two places and the man
page that was supposed to be updated when rgw selinux changes were
proposed did not get updated properly. Fixing this by moving
selinux/ceph_selinux.8 to man/ceph_selinux.8. Also, populate EXTRA_DIST
with ceph_selinux.8.

Signed-off-by: Boris Ranto <branto@redhat.com>
2015-10-06 18:08:15 +02:00
Nathan Cutler
378d56d1e2 man/Makefile-server.am: conditionalize make ceph_selinux manpage
http://tracker.ceph.com/issues/13353 Fixes: #13353

Modified-by: Boris Ranto <branto@redhat.com>
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-10-06 18:08:15 +02:00
Boris Ranto
c52eb995e0 Add initial SELinux support
This patch modifies the build system and spec file to provide a support
for SELinux enforcing in an opt-in matter via ceph-selinux package.

Signed-off-by: Boris Ranto <branto@redhat.com>
2015-08-05 15:21:41 +02:00
Krzysztof Kosiński
6ed554ce1b 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-16 10:32:34 +02:00
Loic Dachary
44d6429a5d Merge pull request #4412 from tchaikov/wip-add-man-page
doc: add man page for ceph-create-keys

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-05-12 16:03:07 +02:00
Loic Dachary
0c715f6971 Merge pull request #4532 from dachary/wip-init-system-detection
ceph-detect-init helper and associated tests

Reviewed-by: Ken Dreyer <kdreyer@redhat.com>
Reviewed-by: Sage Weil <sage@redhat.com>
2015-05-07 22:21:26 +02:00
Kefu Chai
5b2357e663 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-06 10:17:42 +08:00
Loic Dachary
35a16ffc1e ceph-detect-init: integration with automake / make check
* 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>
2015-05-06 01:54:36 +02:00
Sage Weil
7f209b4bc8 Merge remote-tracking branch 'gh/next' 2015-05-05 09:53:51 -07:00
Kefu Chai
156e55b7f9 man: do not dist man pages if sphinx is not available
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-05-05 02:00:02 +08:00
Kefu Chai
27cee2f1f4 doc: add ceph-create-keys.8
Fixes: #10725
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-22 21:35:01 +08:00
Kefu Chai
b2b443cd4a man: fix the description in NAME section
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-21 21:12:45 +08:00
Kefu Chai
1926bb9490 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 23:26:50 +08:00
Kefu Chai
6dd570476c man: ignore fieldlist when getting desc for manpages
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>
2015-04-07 23:26:50 +08:00
Kefu Chai
707a2f77c4 man: appease sphinx by providing a toc doc
Fixes: #11324
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 23:26:50 +08:00
Kefu Chai
c7effab565 man: point man/conf.py and Makefile to doc/man
Fixes: #11320
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 23:26:49 +08:00
Kefu Chai
0e07ccc197 man: move man/8/*.rst back to doc/man/8
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>
2015-04-07 23:26:49 +08:00
Kefu Chai
d8911b4bab doc: fix a typo which use "::" for ":"
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 23:26:49 +08:00
Kefu Chai
e8ad0b5a3a doc: fix sphinx warnings
* kill "Inline strong start-string without end-string" warning by
  removing superfluous '*'

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 23:26:49 +08:00
Kefu Chai
2924d3c615 doc: remove duplicated option doc
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>
2015-04-07 23:26:49 +08:00
John Spray
4d921ee6b7 Merge pull request #4265 from trociny/wip-11319
ceph daemonperf: add watch interval and count parameters

Reviewed-by: John Spray <john.spray@redhat.com>
2015-04-07 11:58:54 +01:00
Jason Dillaman
3a7b28d9a2 rbd: add feature enable/disable support
Mutable image features can now be enabled/disabled via
the rbd CLI.

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2015-04-06 13:14:35 -04:00
Mykola Golub
c0c55c99ba doc: add daemon and daemonperf commands description to man
Signed-off-by: Mykola Golub <mgolub@mirantis.com>
2015-04-06 16:55:08 +03:00
Loic Dachary
e39070fea7 man: using sphinx-1.0-build if no sphinx-build
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>
2015-04-03 02:59:58 +02:00
Loic Dachary
1433315b69 Merge pull request #4115 from dzafman/wip-dzmanfix
doc, mon: Add ceph osd pool get <poolname> all to man page

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-04-03 01:33:07 +02:00
Loic Dachary
a3cf004411 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-03 00:22:01 +02:00
David Zafman
81dca503f2 doc: Fix .gitignore for man directory
Caused by: 301fe6cbf2

Signed-off-by: David Zafman <dzafman@redhat.com>
2015-04-02 11:47:18 -07:00
David Zafman
d51b8b35a1 doc: Add ceph osd pool get <poolname> all to man page
Caused by: ea6192116c

Signed-off-by: David Zafman <dzafman@redhat.com>
2015-04-02 11:36:28 -07:00
Nilamdyuti Goswami
f89b60f116 doc: Updates the radosgw man page with some changes.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2015-04-02 23:23:14 +05:30
Nilamdyuti Goswami
d198d69bcc doc: Updates the configuration of mod_proxy_fcgi in terms of localhost
tcp and unix domain socket.

Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2015-04-02 22:59:55 +05:30
Kefu Chai
f5f48327e4 doc: remove generated man pages
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-03-24 12:36:41 +08:00
Kefu Chai
301fe6cbf2 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-24 12:36:41 +08:00
Sage Weil
0bee27461d Merge remote-tracking branch 'gh/hammer'
Conflicts:
	src/gmock
2015-03-23 12:45:16 -07:00
Nilamdyuti Goswami
3e3d954b8e doc: Adds updated radosgw-admin man page under man/
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2015-03-23 16:39:18 +05:30
Nilamdyuti Goswami
923ab6e7d1 doc: Adds updated radosgw man page under man/
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2015-03-23 16:35:27 +05:30
Nilamdyuti Goswami
db80e45df0 doc: Adds updated radosgw man page under man/
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2015-03-23 16:35:27 +05:30
David Zafman
0a0d8f691e doc: Regenerate man/ceph.8 based on ceph.rst changes
Signed-off-by: David Zafman <dzafman@redhat.com>
2015-03-22 15:28:17 -07:00
Sage Weil
d26a9dce5e Merge remote-tracking branch 'gh/hammer'
Conflicts:
	PendingReleaseNotes
	src/Makefile.am
	src/gmock
	src/test/Makefile.am
2015-03-19 12:41:04 -07:00
Sage Weil
cfecd125fe Merge pull request #3988 from ceph/wip-refine-build-configuration-hammer
Refine build configuration for hammer

Reviewed-by: Sage Weil <sage@redhat.com>
2015-03-19 11:31:31 -07:00
Josh Durgin
a53336accf Merge pull request #3904 from yuyuyu101/wip-librbd-metadata
Wip librbd metadata

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2015-03-17 20:42:18 -07:00
Sage Weil
2a5ad8e3f7 Merge remote-tracking branch 'gh/hammer'
Conflicts:
	src/gmock
	src/msg/xio/XioPortal.h
2015-03-17 10:57:13 -07:00
David Zafman
a69055f7d5 Merge pull request #3982 from dzafman/wip-10678-2
Update ceph.8 man page to match ceph -h output

Reviewed-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2015-03-13 17:58:56 -07:00
David Zafman
f4bc48d954 doc: Fix ceph command manpage to match ceph -h (hammer)
Include rebuilt man/ceph.8

Fixes: #10678

Signed-off-by: David Zafman <dzafman@redhat.com>
2015-03-13 17:00:10 -07:00
David Zafman
9495de4726 doc: Fix ceph command manpage to match ceph -h (firefly)
Improve synopsis section
Fixes: #10676

Signed-off-by: David Zafman <dzafman@redhat.com>
(cherry picked from commit 9ac488c1eb0e30511079ba05aaf11c79615b3940)

Conflicts:

	doc/man/8/ceph.rst
	man/ceph.8
2015-03-13 16:59:39 -07:00
Haomai Wang
da9a057216 librbd: Add metadata_get method to support single metadata key retrieve
Signed-off-by: Haomai Wang <haomaiwang@gmail.com>
2015-03-13 22:52:42 +08:00