[Libguestfs] [PATCH v2v 1/2] docs: Remove documentation for -o json in preparation for removal

Richard W.M. Jones rjones at redhat.com
Mon Apr 11 10:11:01 UTC 2022


I would like to remove the -o json option in virt-v2v 2.2.

It was added to support KubeVirt, but never actually used.  It is
better for specific targets to implement a proper output mode (as we
will eventually do for KubeVirt) rather than relying on a custom
templating language which knows nothing about the target.

This preparatory patch removes only the documentation, although it
leaves a note in the main manual page that the feature existed and is
deprecated.
---
 docs/virt-v2v-output-local.pod | 55 ----------------------------------
 docs/virt-v2v.pod              | 11 ++-----
 2 files changed, 2 insertions(+), 64 deletions(-)

diff --git a/docs/virt-v2v-output-local.pod b/docs/virt-v2v-output-local.pod
index a5f155cbc4..d2a1c2702a 100644
--- a/docs/virt-v2v-output-local.pod
+++ b/docs/virt-v2v-output-local.pod
@@ -11,9 +11,6 @@ or libvirt
 
  virt-v2v [-i* options] -o qemu -os DIRECTORY [--qemu-boot]
 
- virt-v2v [-i* options] -o json -os DIRECTORY
-                        [-oo json-disks-pattern=PATTERN]
-
  virt-v2v [-i* options] -o null
 
 =head1 DESCRIPTION
@@ -57,13 +54,6 @@ above, a shell script is created which contains the raw qemu command
 you would need to boot the guest.  However the shell script is not
 run, I<unless> you also add the I<--qemu-boot> option.
 
-=item B<-o json -os> C<DIRECTORY>
-
-This converts the guest to files in C<DIRECTORY>.  The metadata
-produced is a JSON file containing the majority of the data virt-v2v
-gathers during the conversion.
-See L</OUTPUT TO JSON> below.
-
 =item B<-o null>
 
 The guest is converted, but the final result is thrown away and no
@@ -150,51 +140,6 @@ Define the final guest in libvirt:
 
 =back
 
-=head1 OUTPUT TO JSON
-
-The I<-o json> option produces the following files by default:
-
- NAME.json                     JSON metadata.
- NAME-sda, NAME-sdb, etc.      Guest disk(s).
-
-where C<NAME> is the guest name.
-
-It is possible to change the pattern of the disks using the
-I<-oo json-disks-pattern=...> option: it allows parameters in form of
-C<%{...}> variables, for example:
-
- -oo json-disks-pattern=disk%{DiskNo}.img
-
-Recognized variables are:
-
-=over 4
-
-=item C<%{DiskNo}>
-
-The index of the disk, starting from 1.
-
-=item C<%{DiskDeviceName}>
-
-The destination device of the disk, e.g. C<sda>, C<sdb>, etc.
-
-=item C<%{GuestName}>
-
-The name of the guest.
-
-=back
-
-Using a pattern it is possible use subdirectories for the disks,
-even with names depending on variables; for example:
-
- -oo json-disks-pattern=%{GuestName}-%{DiskNo}/disk.img
-
-The default pattern is C<%{GuestName}-%{DiskDeviceName}>.
-
-If the literal C<%{...}> text is needed, it is possible to avoid the
-escape it with a leading C<%>; for example,
-C<%%{GuestName}-%{DiskNo}.img> will create file names for the
-disks like C<%%{GuestName}-1.img>, C<%%{GuestName}-2.img>, etc.
-
 =head1 SEE ALSO
 
 L<virt-v2v(1)>.
diff --git a/docs/virt-v2v.pod b/docs/virt-v2v.pod
index 69bdbbd462..4e912b6c16 100644
--- a/docs/virt-v2v.pod
+++ b/docs/virt-v2v.pod
@@ -431,14 +431,7 @@ guest is uploaded to Glance.  See L<virt-v2v-output-openstack(1)>.
 
 =item B<-o> B<json>
 
-Set the output method to I<json>.
-
-In this mode, the converted guest is written to a local directory
-specified by I<-os /dir> (the directory must exist), with a JSON file
-containing the majority of the metadata that virt-v2v gathered during
-the conversion.
-
-See L<virt-v2v-output-local(1)>.
+This option is deprecated and will be removed in S<virt-v2v 2.2>.
 
 =item B<-o> B<libvirt>
 
@@ -719,7 +712,7 @@ The location of the storage for the converted guest.
 For I<-o libvirt>, this is a libvirt directory pool
 (see S<C<virsh pool-list>>) or pool UUID.
 
-For I<-o json>, I<-o local> and I<-o qemu>, this is a directory name.
+For I<-o local> and I<-o qemu>, this is a directory name.
 The directory must exist.
 
 For I<-o rhv-upload>, this is the name of the destination Storage
-- 
2.35.1



More information about the Libguestfs mailing list