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>
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 ed0653b493
This license declaration omitted a version number.
Some time later ef7418421b 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>
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>
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>
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>
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>
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>
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>
* 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>
