Re: [libvirt] [PATCH] virt-admin: Document srv-list command in virt-admin's man page

[Erik Skultety]

On 08/09/16 10:27, Andrea Bolognani wrote:
> On Wed, 2016-09-07 at 13:43 +0200, Erik Skultety wrote:
>> srv-list command was missing in the man page.
>>  
>> Signed-off-by: Erik Skultety 
>> ---
>>   tools/virt-admin.pod | 14 ++
>>   1 file changed, 14 insertions(+)
>>  
>> diff --git a/tools/virt-admin.pod b/tools/virt-admin.pod
>> index 2199038..c74707a 100644
>> --- a/tools/virt-admin.pod
>> +++ b/tools/virt-admin.pod
>> @@ -143,6 +143,20 @@ libvirtd:///system is used.
>>   
>>   =back
>>   
>> +=head1 DAEMON COMMANDS
>> +
>> +Following commands allow to monitor daemon's state as well as directly 
>> change
>> +its internal configuration.
> 
> s/Following/The following/
> s/daemon's/the daemon's/
> 
> Moreover, I see "Following commands" is used throughout the
> man page: all other occurences should probably be changed as
> well, in a separate patch of course.
> 

Yep,
http://dictionary.cambridge.org/grammar/british-grammar/following-or-the-following,
it makes sense, thanks for pointing that out, I can add English to my
"TO LEARN" list once again :Panyway, I adjusted and pushed along
with the separate patch you mentioned.

Erik

>> +
>> +=over 4
>> +
>> +=item B
>> +
>> +Lists all manageable servers on daemon the client is currently connected to
>> +through administration interface.
> 
> How about something like this?
> 
>   List all manageable servers that are part of the deamon the
>   client is currently connected to.
> 
> I'm not sure if "being part of" is a technically sound
> description of the relationship between servers and daemons,
> you tell me ;) But "on" doesn't sound right either.
> 
> I removed the "through administration interface" bit because
> it seemed quite redundant - this is virt-admin(1) after all,
> so of course all connections we might refer to will have been
> made through the admin interface.
> 
>> +
>> +=back
>> +
>>   =head1 SERVER COMMANDS
>>   
>>   Following commands manipulate daemon's server internal configuration.
> 
> ACK whether or not you decide to go with my suggested changes,
> as the additional documentation is valuable as is and I'm no
> native speaker either :)
> 
> -- 
> Andrea Bolognani / Red Hat / Virtualization
> 

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] [PATCH] virt-admin: Document srv-list command in virt-admin's man page

[Andrea Bolognani]

On Wed, 2016-09-07 at 13:43 +0200, Erik Skultety wrote:
> srv-list command was missing in the man page.
> 
> Signed-off-by: Erik Skultety 
> ---
>  tools/virt-admin.pod | 14 ++
>  1 file changed, 14 insertions(+)
> 
> diff --git a/tools/virt-admin.pod b/tools/virt-admin.pod
> index 2199038..c74707a 100644
> --- a/tools/virt-admin.pod
> +++ b/tools/virt-admin.pod
> @@ -143,6 +143,20 @@ libvirtd:///system is used.
>  
>  =back
>  
> +=head1 DAEMON COMMANDS
> +
> +Following commands allow to monitor daemon's state as well as directly change
> +its internal configuration.

s/Following/The following/
s/daemon's/the daemon's/

Moreover, I see "Following commands" is used throughout the
man page: all other occurences should probably be changed as
well, in a separate patch of course.

> +
> +=over 4
> +
> +=item B
> +
> +Lists all manageable servers on daemon the client is currently connected to
> +through administration interface.

How about something like this?

  List all manageable servers that are part of the deamon the
  client is currently connected to.

I'm not sure if "being part of" is a technically sound
description of the relationship between servers and daemons,
you tell me ;) But "on" doesn't sound right either.

I removed the "through administration interface" bit because
it seemed quite redundant - this is virt-admin(1) after all,
so of course all connections we might refer to will have been
made through the admin interface.

> +
> +=back
> +
>  =head1 SERVER COMMANDS
>  
>  Following commands manipulate daemon's server internal configuration.

ACK whether or not you decide to go with my suggested changes,
as the additional documentation is valuable as is and I'm no
native speaker either :)

-- 
Andrea Bolognani / Red Hat / Virtualization

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list