[Libguestfs] [PATCH 01/16] generator: Fix unescaped '<' and '>' in api descriptions

[Richard W.M. Jones]

On Tue, Mar 27, 2012 at 04:00:43PM +0100, Matthew Booth wrote:
> ---
>  generator/generator_actions.ml |    9 +++++----
>  1 files changed, 5 insertions(+), 4 deletions(-)

I've looked at this patch again, and it's wrong:

> diff --git a/generator/generator_actions.ml b/generator/generator_actions.ml
> index 68a7bf6..fcf363f 100644
> --- a/generator/generator_actions.ml
> +++ b/generator/generator_actions.ml
> @@ -4664,7 +4664,7 @@ This creates an ext2/3/4 filesystem on C<device> with
>  an external journal on C<journal>.  It is equivalent
>  to the command:
>  
> - mke2fs -t fstype -b blocksize -J device=<journal> <device>
> + mke2fs -t fstype -b blocksize -J device=E<lt>journalE<gt> E<lt>deviceE<gt>

These should not be quoted, since they are in a verbatim section.

>  See also C<guestfs_mke2journal>.");
>  
> @@ -5330,7 +5330,7 @@ For example, in guestfish you could use the following command
>  to examine the boot script (usually called C</init>)
>  contained in a Linux initrd or initramfs image:
>  
> - initrd-cat /boot/initrd-<version>.img init
> + initrd-cat /boot/initrd-E<lt>versionE<gt>.img init

Ditto.

>  See also C<guestfs_initrd_list>.");
>  
> @@ -6560,8 +6560,9 @@ List all Linux md devices.");
>     [],
>     "obtain metadata for an MD device",
>     "\
> -This command exposes the output of 'mdadm -DY <md>'. The following fields are
> -usually present in the returned hash. Other fields may also be present.
> +This command exposes the output of 'mdadm -DY E<lt>mdE<gt>'. The following
> +fields are usually present in the returned hash. Other fields may also be
> +present.
>  
>  =over

This is OK.

I'm going to revert the two wrong hunks.

Rich.

-- 
Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones
virt-p2v converts physical machines to virtual machines.  Boot with a
live CD or over the network (PXE) and turn machines into Xen guests.
http://et.redhat.com/~rjones/virt-p2v