From f21f48b73c500022f5ea309fd0a0cd5196a51b9b Mon Sep 17 00:00:00 2001 From: Alexandra Settle Date: Wed, 13 Feb 2019 11:19:31 +0000 Subject: [PATCH] Fixing target for cross-ref 'get_data_dir' At the moment, the `get_data_dir` ref in [0] is not pointing to anything. This patch amends that and links it to (what I think) is 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 --- doc/source/overview_policies.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/overview_policies.rst b/doc/source/overview_policies.rst index 11d509e16b..c66e3acbbf 100644 --- a/doc/source/overview_policies.rst +++ b/doc/source/overview_policies.rst @@ -561,9 +561,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 :func:`.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 ----------------