[Openstack-docs] Inconsistency wrt hostnames in replaceable

Shaun McCance shaunm at gnome.org
Fri Nov 8 17:57:09 UTC 2013


Reviewing some patches, I realize we're not all on the same page when it
comes to whether to put hostnames in replaceable. That is, which one of
these do we write?

qpid_hostname=controller

qpid_hostname=<replaceable>controller</replaceable>

In the latter case, you're making it clear that it can be replaced with
something different, if you're doing things differently. In the former,
replaceable is reserved for things that must be replaced by the user,
like passwords or randomly generated IDs.

I tend to lean toward only using replaceable when we expect the user
must replace the text, so that it stands out in the reader's mind. After
all, this is OpenStack, so everything *could* conceivably be changed. We
don't want to wrap the whole book in one big replaceable. :)

--
Shaun





More information about the Openstack-docs mailing list