Files
libguestfs/docs
Richard W.M. Jones 085815ce10 build: Describe how to set up check-valgrind rules correctly.
Since we enabled parallel tests, you can no longer run tests
under valgrind merely by doing:

  TESTS_ENVIRONMENT = $(top_builddir)/run --test $(VG)
  check-valgrind:
      $(MAKE) check VG="@VG@"

The reason is that the parallel tests framework doesn't run
``$(TESTS_ENVIRONMENT) <test>''.  It inserts some other processes in
between the environment and the test, so you end up valgrinding some
unrelated process (currently the 'env' program).

In run.in, remove out of date documentation for using $(VG).
In guestfs-hacking(1), document how to do it properly.
2016-02-22 17:55:13 +00:00
..

This directory contains miscellaneous manual pages which don't fit
elsewhere.

Most libguestfs documentation is in manual pages.  The source for
those manual pages are POD files (*.pod), and they are normally
located next to the source files they relate to (eg. guestfish
documentation is in fish/guestfish.pod).

All manual pages are available online at http://libguestfs.org/

The main API documentation is: http://libguestfs.org/guestfs.3.html