openstack/swift
Code Issues Proposed changes

Fixing target for cross-ref 'get_data_dir'

Browse Source 
At the moment, the `get_data_dir` ref in [0] is not
pointing to anything. This patch amends that and
links it to the correct policy string.

Without updating this change, local tox builds
for swift documentation fail with the following
error: Warning, treated as error: /home/asettle/openstack/swift/doc
/source/overview_policies.rst:555:more than one target found for
cross-reference u'get_data_dir': swift.obj.reconstructor.get_data_dir,
swift.obj.diskfile.get_data_dir, swift.obj.replicator.get_data_dir

[0] https://docs.openstack.org/swift/rocky/overview_policies.html#object-server

Change-Id: I7c699e4fc46706a4971fce5a85ed335f471d3a2b
This commit is contained in:
Alexandra Settle 2019-02-13 11:19:31 +00:00 committed by Tim Burke
parent 002d21991e
commit 693f931a59
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/overview_policies.rst
View File

@ -568,9 +568,9 @@ included implementation of :class:`.Diskfile` lays out the directory structure
described earlier but that's owned within :class:`.Diskfile`; external modules
have no visibility into that detail. A common function is provided to map
various directory names and/or strings based on their policy index. For example
:class:`.Diskfile` defines ``get_data_dir`` which builds off of a generic
:func:`.get_policy_string` to consistently build policy aware strings for
various usage.
:class:`.Diskfile` defines :func:`~swift.obj.diskfile.get_data_dir` which builds
off of a generic :func:`.get_policy_string` to consistently build policy aware
strings for various usage.
Container Server
----------------