summaryrefslogtreecommitdiff
path: root/man
Commit message (Collapse)AuthorAgeFilesLines
* man: skip directive starting with ".."Kefu Chai2018-08-151-0/+2
| | | | | | | | | | | | | the target definition of hyper link looks like: .. _a-reference-label: there is chance that we need to add `:ref:` referencing man pages, and add target definition at the beginning of the manapges for the references. in that case, we need to skip the ref directives when looking for the title of the manpage. Signed-off-by: Kefu Chai <kchai@redhat.com>
* legal: remove doc license ambiguityNathan Cutler2018-03-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | The license applicable to the files under doc/ was originally declared (in the top-level file COPYING) to be "Creative Commons Attribution-ShareAlike (CC BY-SA)" by ed0653b493a3f919a3abc37a0aa9b5aa29ae0b0e This license declaration omitted a version number. Some time later ef7418421b3748c712019c8aedd02b8005c1e1ea was merged, mentioning CC-BY-SA-1.0 as one of the Ceph source code licenses. Although the purpose of that commit was only to summarize the canonical license information from COPYING, it unintentionally became the only place in the source code where the doc license version was specified. In March 2018, the Debian project warned that CC-BY-SA-1.0 does not meet its criteria for inclusion in the "free" section of the Debian distribution. (For that, at least version 3.0 must be used.) This new commit removes the doc license ambiguity by setting it to CC-BY-SA-3.0 in all places where the license is mentioned. The exact spelling of the license name is taken from https://spdx.org/licenses/ Fixes: http://tracker.ceph.com/issues/23336 Signed-off-by: Nathan Cutler <ncutler@suse.com>
* doc/man: avoid file builtin to solve build errorPatrick Donnelly2016-11-151-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | Sphinx running with Python 3.X fails: # Sphinx version: 1.4.8 # Python version: 3.5.2 (CPython) # Docutils version: 0.12 release # Jinja2 version: 2.8 # Last messages: # Loaded extensions: Traceback (most recent call last): File "/usr/lib/python3.5/site-packages/sphinx/cmdline.py", line 243, in main opts.warningiserror, opts.tags, opts.verbosity, opts.jobs) File "/usr/lib/python3.5/site-packages/sphinx/application.py", line 137, in __init__ confoverrides or {}, self.tags) File "/usr/lib/python3.5/site-packages/sphinx/config.py", line 287, in __init__ execfile_(filename, config) File "/usr/lib/python3.5/site-packages/sphinx/util/pycompat.py", line 130, in execfile_ exec_(code, _globals) File "conf.py", line 56, in <module> File "conf.py", line 47, in _get_manpages File "conf.py", line 12, in _get_description NameError: name 'file' is not defined Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
* remove autotoolsSage Weil2016-09-074-102/+0
| | | | Signed-off-by: Sage Weil <sage@redhat.com>
* man/Makefile-client.am: drop legacy cephfs toolNathan Cutler2016-07-261-5/+0
| | | | | | Somehow c76c31d312ce7a623acd99dbdedfe471c0cd445f missed this bit. Signed-off-by: Nathan Cutler <ncutler@suse.com>
* doc,cmake: do not scan non-man pages when building man pagesKefu Chai2016-05-241-1/+1
| | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* cmake: build man pagesKefu Chai2016-05-121-42/+3
| | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* automake: use :: rule for adding targetKefu Chai2016-05-031-1/+1
| | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* cmake: conditionally install man pagesKefu Chai2016-03-261-5/+15
| | | | | | | | 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>
* autotools: add rbdmap to dist_man_MANSKefu Chai2016-03-252-1/+3
| | | | | | | this fixes the rpm/deb build failure was introduced by 20c8650 Signed-off-by: Kefu Chai <kchai@redhat.com>
* selinux: Allow log files to be located in /var/log/radosgwBoris Ranto2016-02-111-2/+52
| | | | | | | | | | | | | | | | 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>
* man: stub manpage for rbd-mirrorJosh Durgin2016-02-041-0/+1
| | | | Signed-off-by: Josh Durgin <jdurgin@redhat.com>
* add rbd-nbd docYunchuan Wen2015-11-212-0/+2
| | | | Signed-off-by: Yunchuan Wen <yunchuan.wen@kylin-cloud.com>
* selinux: Fix man page locationBoris Ranto2015-10-062-6/+52
| | | | | | | | | | 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>
* man/Makefile-server.am: conditionalize make ceph_selinux manpageNathan Cutler2015-10-061-1/+5
| | | | | | | http://tracker.ceph.com/issues/13353 Fixes: #13353 Modified-by: Boris Ranto <branto@redhat.com> Signed-off-by: Nathan Cutler <ncutler@suse.com>
* Add initial SELinux supportBoris Ranto2015-08-052-1/+326
| | | | | | | 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>
* automake: Fix out-of-tree build.Krzysztof Kosiński2015-07-161-1/+1
| | | | | | | | 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>
* Merge pull request #4412 from tchaikov/wip-add-man-pageLoic Dachary2015-05-122-0/+2
|\ | | | | | | | | | | doc: add man page for ceph-create-keys Reviewed-by: Loic Dachary <ldachary@redhat.com>
| * doc: add ceph-create-keys.8Kefu Chai2015-04-222-0/+2
| | | | | | | | | | Fixes: #10725 Signed-off-by: Kefu Chai <kchai@redhat.com>
* | Merge pull request #4532 from dachary/wip-init-system-detectionLoic Dachary2015-05-071-0/+1
|\ \ | | | | | | | | | | | | | | | ceph-detect-init helper and associated tests Reviewed-by: Ken Dreyer <kdreyer@redhat.com> Reviewed-by: Sage Weil <sage@redhat.com>
| * | ceph-detect-init: integration with automake / make checkLoic Dachary2015-05-061-0/+1
| |/ | | | | | | | | | | | | | | | | * 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>
* | configure.ac: add an option: --with-man-pagesKefu Chai2015-05-061-1/+1
| | | | | | | | | | | | | | | | * 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>
* | Merge remote-tracking branch 'gh/next'Sage Weil2015-05-051-0/+2
|\ \ | |/ |/|
| * man: do not dist man pages if sphinx is not availableKefu Chai2015-05-051-0/+2
| | | | | | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* | man: fix the description in NAME sectionKefu Chai2015-04-211-9/+10
|/ | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* man: enable warning msgs for "all" targetKefu Chai2015-04-071-5/+6
| | | | | | | | | | | | | * 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>
* man: ignore fieldlist when getting desc for manpagesKefu Chai2015-04-071-10/+22
| | | | | | | | 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>
* man: appease sphinx by providing a toc docKefu Chai2015-04-071-0/+3
| | | | | Fixes: #11324 Signed-off-by: Kefu Chai <kchai@redhat.com>
* man: point man/conf.py and Makefile to doc/manKefu Chai2015-04-072-4/+5
| | | | | Fixes: #11320 Signed-off-by: Kefu Chai <kchai@redhat.com>
* man: move man/8/*.rst back to doc/man/8Kefu Chai2015-04-0731-5897/+0
| | | | | | | | | 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>
* doc: fix a typo which use "::" for ":"Kefu Chai2015-04-071-1/+1
| | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* doc: fix sphinx warningsKefu Chai2015-04-071-1/+1
| | | | | | | * kill "Inline strong start-string without end-string" warning by removing superfluous '*' Signed-off-by: Kefu Chai <kchai@redhat.com>
* doc: remove duplicated option docKefu Chai2015-04-071-4/+0
| | | | | | | | | | 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>
* Merge pull request #4265 from trociny/wip-11319John Spray2015-04-071-0/+28
|\ | | | | | | | | ceph daemonperf: add watch interval and count parameters Reviewed-by: John Spray <john.spray@redhat.com>
| * doc: add daemon and daemonperf commands description to manMykola Golub2015-04-061-0/+28
| | | | | | | | Signed-off-by: Mykola Golub <mgolub@mirantis.com>
* | rbd: add feature enable/disable supportJason Dillaman2015-04-061-8/+16
|/ | | | | | | Mutable image features can now be enabled/disabled via the rbd CLI. Signed-off-by: Jason Dillaman <dillaman@redhat.com>
* man: using sphinx-1.0-build if no sphinx-buildLoic Dachary2015-04-031-2/+2
| | | | | | | | 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>
* Merge pull request #4115 from dzafman/wip-dzmanfixLoic Dachary2015-04-032-0/+6
|\ | | | | | | | | | | doc, mon: Add ceph osd pool get <poolname> all to man page Reviewed-by: Loic Dachary <ldachary@redhat.com>
| * doc: Fix .gitignore for man directoryDavid Zafman2015-04-021-0/+2
| | | | | | | | | | | | Caused by: 301fe6cbf2c8b04d0650fe60de65c3cdc7a8ac95 Signed-off-by: David Zafman <dzafman@redhat.com>
| * doc: Add ceph osd pool get <poolname> all to man pageDavid Zafman2015-04-021-0/+4
| | | | | | | | | | | | Caused by: ea6192116cb1af4b8f4964cf7d5c69f164680205 Signed-off-by: David Zafman <dzafman@redhat.com>
* | man: add conf.py to the list of distributed filesLoic Dachary2015-04-031-0/+2
| | | | | | | | | | | | Otherwise packages won't build as it's not included in the tarbal. Signed-off-by: Loic Dachary <ldachary@redhat.com>
* | doc: Updates the radosgw man page with some changes.Nilamdyuti Goswami2015-04-021-6/+9
| | | | | | | | Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
* | doc: Updates the configuration of mod_proxy_fcgi in terms of localhostNilamdyuti Goswami2015-04-021-58/+59
|/ | | | | | tcp and unix domain socket. Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
* doc: remove generated man pagesKefu Chai2015-03-2431-9770/+0
| | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* doc: generate man pages in man/MakefileKefu Chai2015-03-2433-0/+5914
| | | | | | | | | | | * 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 remote-tracking branch 'gh/hammer'Sage Weil2015-03-231-9/+29
|\ | | | | | | | | Conflicts: src/gmock
| * doc: Regenerate man/ceph.8 based on ceph.rst changesDavid Zafman2015-03-221-9/+29
| | | | | | | | Signed-off-by: David Zafman <dzafman@redhat.com>
* | doc: Adds updated radosgw-admin man page under man/Nilamdyuti Goswami2015-03-231-36/+319
| | | | | | | | Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
* | doc: Adds updated radosgw man page under man/Nilamdyuti Goswami2015-03-231-8/+83
| | | | | | | | Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
* | doc: Adds updated radosgw man page under man/Nilamdyuti Goswami2015-03-231-54/+117
| | | | | | | | Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
View Lorry Controller Status