[libvirt] [PATCH] docs: mention domain <clock> improvements

[Eric Blake]

On 05/17/2010 03:27 PM, Chris Lalancette wrote:
>> +	  <dt><code>track</code></dt>
>> +	  <dd>
>> +	    The <code>track</code> attribute specifies what the timer
>> +	    tracks, and can be "boot", "guest", or "wall".
>> +	    Only valid for <code>name="rtc"</code>
>> +	    or <code>name="platform"</code>.
> 
> Tough one.  This doesn't tell people much about what they should be
> choosing for "track", and hence isn't that useful.  You may want to
> add more about what this means.  From what I can tell, it's actually
> keeping track of how the RTC is getting updated.  If it's set to "guest",
> then it is always set relative to the number of guest cycles that have
> passed.  If it's set to "wall", it's relative to the actual time that
> has passed from the host's POV.  I'm not sure about "boot".

Now you see my quandary of why I asked for feedback!  I'm documenting
someone else's work, and getting lost in all the options.  Laine, since
you own the commit that added <timer>, would you care to lend a hand, so
we can make this documentation useful?  :-)

>>      <h3><a name="elementsDevices">Devices</a></h3>
> 
> My comments are not meant as a discouragement, just improvement; more
> documentation is always helpful!

No discouragement on my side!  I consider my afternoon spent on the
patch as-is to be time well-spent, even if it's not complete yet.

-- 
Eric Blake   eblake at redhat.com    +1-801-349-2682
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 619 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20100517/2e1aa87d/attachment-0001.sig>