Open Stack

I concur, but I was told that '<replaceable>' should be used for controller,
so that's why I have been putting it in to my patches, at least.

----- Original Message -----
From: "Andreas Jaeger" <aj at suse.com>
To: "Shaun McCance" <shaunm at gnome.org>, openstack-docs at lists.openstack.org
Sent: Friday, November 8, 2013 1:10:45 PM
Subject: Re: [Openstack-docs] Inconsistency wrt hostnames in replaceable

On 11/08/2013 06:57 PM, Shaun McCance wrote:
> 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. :)


Yeah, I added some more as part of a review comment. We had them always
in a few places.

I tend to agree that controller shouldn't be a replaceable.

Btw. please remember to document such decisions at:

https://wiki.openstack.org/wiki/Documentation/Conventions#Install_Guide

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126

_______________________________________________
Openstack-docs mailing list
Openstack-docs at lists.openstack.org
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs