Re: [Libguestfs] [PATCH libnbd 0/4] Miscellaneous Rust cleanups
On Wed, Oct 18, 2023 at 09:22:55AM -0500, Eric Blake wrote:
On Tue, Oct 10, 2023 at 03:06:06PM +0100, Richard W.M. Jones wrote:
> Add an overview libnbd-rust(3) man page pointing to the real
> documentation. This is like OCaml & Golang.
>
> When reviewing the real rustdocs I noticed they basically converted
> the man pages into plain text, resulting in lots of problems such as
> internal links not working, no `code` annotations, etc. So I wrote a
> simple POD to rustdoc translator. It is by no means perfect, but it
> fixes many of the issues.
>
> Also build the examples, to make sure we don't get any regressions.
For the series:
Reviewed-by: Eric Blake <eblake(a)redhat.com>
There is an XXX about displying links rather than just italicized
texts for pod L<> constructs linking to non-libnbd pages, which can be
solved later, but your approach for now is definitely better than
plain text.
Yeah I couldn't work out how that can be done, except to add an
explicit link to one of those man page sites (and then, which one?!)
I don't see existing Rust pages linking to man pages, unfortunately.
Thanks for the review.
Rich.
--
Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones
Read my programming and virtualization blog: http://rwmj.wordpress.com
virt-top is 'top' for virtual machines. Tiny program with many
powerful monitoring features, net stats, disk stats, logging, etc.
http://people.redhat.com/~rjones/virt-top