[libvirt] Virsh reference is out of date, should it be updated from the man page?
Daniel P. Berrangé
berrange at redhat.com
Mon Sep 3 10:25:36 UTC 2018
On Mon, Sep 03, 2018 at 12:09:42PM +0200, Ján Tomko wrote:
> On Mon, Sep 03, 2018 at 10:04:16AM +0200, Michal Prívozník wrote:
> > On 09/03/2018 09:38 AM, Povilas Kanapickas wrote:
> > > Hi!
> > >
> > > The online virsh command reference at [1] seems to be very out of date
> > > according to [2]. There's much more recent documentation at
> > > tools/virsh.pod in the main libvirt repository.
> >
> > Yes, this is because of lacking manpower. As usual O:-)
> >
> > >
> > > I believe it would be great to update the web docs as they are much more
> > > accessible and convenient to use (especially the one-command-per-page
> > > version).
> > >
>
> AFAIK the "Virsh Command Reference" was intended to provide more
> information than the man page, especially practical usage of the
> commands, not just to have the manpage in HTML.
>
> So providing this extra content with examples would be more worthwhile
> than just a copy of the manpage.
Yes, that is correct - it should be much more verbose information
for it to be useful as a doc. If we just wanted HTML there's already
the ability to convert the POD manpage to HTML.
Regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
More information about the libvir-list
mailing list