Use :envvar: instead of :any: to refer to variables.

Related to: debops/docs#153
ypid · Jul 8, 2016 · 06088e9 · 06088e9
1 parent dc3f3a4
commit 06088e9
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -7,10 +7,10 @@ v0.2.0
 
 *Unreleased*
 
-- | Renamed ``apt_cacher_ng__nginx_upstream`` to :any:`apt_cacher_ng__nginx__upstream`.
-  | Renamed ``apt_cacher_ng__nginx_upstream_servers`` to :any:`apt_cacher_ng__upstream_servers`. [ypid]
+- | Renamed ``apt_cacher_ng__nginx_upstream`` to :envvar:`apt_cacher_ng__nginx__upstream`.
+  | Renamed ``apt_cacher_ng__nginx_upstream_servers`` to :envvar:`apt_cacher_ng__upstream_servers`. [ypid]
 
-- Added :any:`apt_cacher_ng__connect_protocol` to allow to specify which IP
+- Added :envvar:`apt_cacher_ng__connect_protocol` to allow to specify which IP
   version to prefer when contacting upstream mirrors. [ypid]
 
 v0.1.0

diff --git a/defaults/main.yml b/defaults/main.yml
@@ -155,7 +155,7 @@ apt_cacher_ng__proxy: ''
 # Only use IPv4 connections for connecting to upstream mirrors.
 #
 # Defaults to using native order of the system's TCP/IP stack, influenced by
-# the :any:`apt_cacher_ng__bind_address` value.
+# the :envvar:`apt_cacher_ng__bind_address` value.
 apt_cacher_ng__connect_protocol: []
 
 
@@ -275,7 +275,7 @@ apt_cacher_ng__file_perms: '00644'
 #
 # ``lazy``
 #   Check the :file:`_expending_damaged` file in the root of
-#   :any:`apt_cacher_ng__cache_dir` and only enforce permissions on all other
+#   :envvar:`apt_cacher_ng__cache_dir` and only enforce permissions on all other
 #   files if this one file needed to be changed.
 #
 # ``disabled``

diff --git a/tasks/main.yml b/tasks/main.yml
@@ -17,7 +17,7 @@
   when: (apt_cacher_ng__deploy_state in [ 'absent', 'purge' ])
   with_items: '{{ apt_cacher_ng__configuration_files }}'
 
-- name: Ensure required packages are in there desired state
+- name: Ensure specified packages are in there desired state
   apt:
     name: '{{ item }}'
     state: '{{ "latest" if (apt_cacher_ng__deploy_state == "present") else "absent" }}'