Re: [libvirt] [PATCH 08/11] storage: Update docs/formatsecret.html
On 07/06/13 01:14, John Ferlan wrote:
On 05/28/2013 02:39 AM, Osier Yang wrote:
> To mention that the secret type "iscsi" and "ceph" can be used
> to storage pool too.
> ---
> docs/formatsecret.html.in | 10 ++++++----
> 1 file changed, 6 insertions(+), 4 deletions(-)
>
I think you should take the opportunity to describe the available
options a little better in the formatdomain and formatstorage pages. In
fact, 'auth' is not even mentioned on the formatstorage page. Once the
latter is done you could provide the direct "#" link to the page tag.
As said before, it's the things I don't want to touch at this stage,
but since you mentioned it times, I will see if I can add the documents
for pool auth (only).
John
> diff --git a/docs/formatsecret.html.in b/docs/formatsecret.html.in
> index 50c9533..3e306b5 100644
> --- a/docs/formatsecret.html.in
> +++ b/docs/formatsecret.html.in
> @@ -64,8 +64,9 @@
> a single <code>name</code> element that specifies a usage name
> for the secret. The Ceph secret can then be used by UUID or by
> this usage name via the <code><auth></code> element
of
> - a <a href="formatdomain.html#elementsDisks">disk
> - device</a>. <span class="since">Since
0.9.7</span>.
> + a <a href="formatdomain.html#elementsDisks">disk
device</a> or
> + a <a href="formatstorage.html">storage pool (rbd)</a>.
> + <span class="since">Since 0.9.7</span>.
> </p>
>
> <h3>Usage type "iscsi"</h3>
> @@ -76,8 +77,9 @@
> a single <code>target</code> element that specifies a usage name
> for the secret. The iSCSI secret can then be used by UUID or by
> this usage name via the <code><auth></code> element
of
> - a <a href="formatdomain.html#elementsDisks">disk
> - device</a>. <span class="since">Since
1.0.4</span>.
> + a <a href="formatdomain.html#elementsDisks">disk
device</a> or
> + a <a href="formatstorage.html">storage pool
(iscsi)</a>.
> + <span class="since">Since 1.0.4</span>.
> </p>
>
> <h2><a name="example">Example</a></h2>
>