Skip to contentSkip to conversation

xfstests-bld: clean up outdated documentation files

PATCH Applied Eric Biggers 2 participants 2 messages May 17, 2017 – May 18, 2017

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 xfstests-bld: clean up outdated documentation files

From: Eric Biggers <[email protected]>

Replace kvm-xfstests/README and kvm-xfstests/README.GCE with pointers to where the documentation is now. Also delete the top-level README, since it's been replaced with README.md right next to it.

---
 README                  |  85 ---------------------------
 kvm-xfstests/README     |  81 +-------------------------
 kvm-xfstests/README.GCE | 148 +-----------------------------------------------
 3 files changed, 3 insertions(+), 311 deletions(-)
 delete mode 100644 README
README deleted +0 -85
deleted file mode 100644
index ef87668..0000000
@@ -1,85 +0,0 @@
-
-The xfstests-bld package makes it easy to build xfstests in a hermetic
-build environment (so it is not dependent on possibly out-of-date
-distro versions of libaio, xfsprogs, etc.).  It also contains scripts
-which make it easy to run xfstests in a KVM guest.  It is currently
-optimized for ext4 testing, but it should be fairly simple to
-generalize this for testing other file systems.
-
-If you are using debian testing, it is pretty simple to generate your
-own test appliance which uses kvm to run xfstests.  If you are using a
-different distribution, you can fetch a copy of root_fs.img from
-https://www.kernel.org/pub/linux/kernel/people/tytso/kvm-xfstests.
-
-Or you can take a look at the kvm-xfstests/test-appliance/gen-image
-and create something which works for your distribution.  Please let me
-know if create something which works well for other distributions.
-
-1.  "make ; make tarball" to generate the xfstests.tar.gz file.
-2.  cd to kvm-xfstests/test-appliance, and run as root the shell script
-    "gen-image".  This will create the root_fs.img file.
-3.  build a kernel which does not use modules (at least for all of the
-    device drivers required for running under kvm).  There are sample
-    kernel configs found in the top-level kernel-configs directory.
-    Note that if you build a 32-bit i386 kernel, you will need to make
-    to build the root_fs.img file in 32-bit build chroot.  You can use
-    a 32-bit userspace with a 64-bit kernel; in fact, this is a good
-    way to sanity check the ioctl compatibility code.
-4.  Adjust the KERNEL= line in kvm-xfstests/config to point at your
-    kernel's bzImage file.
-5.  cd to kvm-xfstests, and run "kvm-xfstests smoke".  More details of
-    how to run kvm-xfstests can be found in kvm-xfstests/README.  If
-    you adjust the DIR= line in kvm-xfstests, it will not be
-    necessary to be cd'ed into the kvm-xfstests directory before
-    kicking off the shell script.
-
-When the kvm-xfstests is done, it will print a summary of which tests
-passed and failed.  It will also save the output of the test in a
-log.YYYYMMDDHHSS file.  The "get-results" script will parse the log
-file and generate the test summary.
-
-
-Instructions for building a 32-bit test-appliance image in a chroot
--------------------------------------------------------------------
-
-These instructions assumes you are using Debian; it should probably
-work for Ubuntu as well.
-
-If you want to build a 64-bit test image, just remove the --arch=i386
-in step #3, or if you don't want to use a build-chroot, you should be
-able to just use the "./do-all" script all by itself --- or you can
-use the manual instructions described in steps #1 and #2 above.
-
-1)  Install the necessary packages to build host OS
-
-# sudo apt-get install schroot debootstrap
-
-2) Add the following to /etc/schroot.conf, replacing "tytso" with your
-username, and /u1/jessie-root with path where you plan to put your
-build chroot
-
-[jessie]
-description=Debian jessie
-type=directory
-directory=/u1/jessie-root
-users=tytso,root
-root-users=tytso
-
-3) Create the build chroot (again, replace /u1/jessie-root with the
-pathname to your build chroot directory):
-
-# cd /u1
-# debootstrap --arch=i386 jessie /u1/jessie-root
-# schroot -c jessie -u root
-(jessie)root@closure:/u1# apt-get install build-essential autoconf autoconf2.64 automake libgdbm-dev libtool-bin qemu-utils gettext e2fslibs-dev git debootstrap
-(jessie)root@closure:/u1# exit
-
-4) Copy config to config.custom, and then change the lines which
-define SUDO_ENV and BUILD_ENV to:
-
-SUDO_ENV="schroot -c jessie -u root --"
-BUILD_ENV="schroot -c jessie --"
-
-5)  Kick off the build!
-
-./do-all
kvm-xfstests/README +0 -72

74 lines not on this page · raw message

ic/258 generic/263 generic/269 generic/270 generic/277 generic/285 generic/286 generic/294 generic/299 generic/300 generic/306 generic/307 generic/308 generic/309 generic/310 generic/313 generic/314 generic/315 generic/316 generic/317 generic/318 generic/319 shared/218 shared/243 shared/272 shared/289 shared/298
-Failures: generic/318
-END TEST: Ext4 4k block w/ no journal Sun Dec 22 10:01:56 EST 2013
-....
-
-(If there is a missing "END TEST", it's likely because there was a
-kernel bug which caused the kernel to crash before the test run was
-able to complete.)
+This documentation has been moved to Documentation/kvm-quickstart.md and
+Documentation/kvm-xfstests.md.

kvm-xfstests/README.GCE +1 -147

148 lines not on this page · raw message

Signature · 1 line
2.13.0.303.g4ebf302169-goog
#1 lore raw
Quoted 7 lines · Eric Biggers

From: Eric Biggers <[email protected]>

Replace kvm-xfstests/README and kvm-xfstests/README.GCE with pointers to where the documentation is now. Also delete the top-level README, since it's been replaced with README.md right next to it.

Thanks, applied.

- Ted