From: Erik Skultety Date: Fri, 12 Mar 2021 07:34:15 +0000 (+0100) Subject: docs: html.in: Convert 'compiling' to rst X-Git-Tag: v7.2.0-rc1~118 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9f8696d62fd86b932996b5f6c5d45fe22bb420e8;p=thirdparty%2Flibvirt.git docs: html.in: Convert 'compiling' to rst Signed-off-by: Erik Skultety Reviewed-by: Peter Krempa --- diff --git a/docs/compiling.html.in b/docs/compiling.html.in deleted file mode 100644 index df6074780f..0000000000 --- a/docs/compiling.html.in +++ /dev/null @@ -1,115 +0,0 @@ - - - - -

libvirt Installation

- -

Compiling a release tarball

- -

- libvirt uses the standard setup/build/install steps and mandates - that the build directory is different from the source directory: -

- -

-$ xz -dc libvirt-x.x.x.tar.xz | tar xvf -
-$ cd libvirt-x.x.x
-$ meson build

- -

- The meson script can be given options to change its default - behaviour. -

- -

- To get the complete list of the options run the following command: -

- -

-$ meson configure

- -

- When you have determined which options you want to use (if any), - continue the process. -

- -

- Note the use of sudo with the ninja install command - below. Using sudo is only required when installing to a location your - user does not have write access to. Installing to a system location - is a good example of this. -

- -

- If you are installing to a location that your user does have write - access to, then you can instead run the ninja install command - without putting sudo before it. -

- -

-$ meson build [possible options]
-$ ninja -C build
-$ sudo ninja -C build install

- -

- At this point you may have to run ldconfig or a similar utility - to update your list of installed shared libs. -

- -

Building from a GIT checkout

- -

- The libvirt build process uses Meson build system. By default when - the meson is run from within a GIT checkout, it - will turn on -Werror for builds. This can be disabled with - --werror=false, but this is not recommended. -

- -

To build & install libvirt to your home - directory the following commands can be run: -

- -

-$ meson build --prefix=$HOME/usr
-$ ninja -C build
-$ sudo ninja -C build install

- -

- Be aware though, that binaries built with a custom prefix will not - interoperate with OS vendor provided binaries, since the UNIX socket - paths will all be different. To produce a build that is compatible - with normal OS vendor prefixes, use -

- -

-$ meson build -Dsystem=true
-$ ninja -C build
-

- -

- When doing this for day-to-day development purposes, it is recommended - not to install over the OS vendor provided binaries. Instead simply - run libvirt directly from the source tree. For example to run - a privileged libvirtd instance -

- -

-$ su -
-# service libvirtd stop  (or systemctl stop libvirtd.service)
-# /home/to/your/checkout/build/src/libvirtd
-

- -

- It is also possible to run virsh directly from the build tree - using the ./run script (which sets some environment variables): -

- -

-$ pwd
-/home/to/your/checkout/build
-$ ./run ./tools/virsh ....
-

- - diff --git a/docs/compiling.rst b/docs/compiling.rst new file mode 100644 index 0000000000..62519b6bdb --- /dev/null +++ b/docs/compiling.rst @@ -0,0 +1,95 @@ +==================== +libvirt Installation +==================== + +.. contents:: + +Compiling a release tarball +--------------------------- + +libvirt uses the standard setup/build/install steps and mandates that +the build directory is different from the source directory: + +:: + + $ xz -dc libvirt-x.x.x.tar.xz | tar xvf - + $ cd libvirt-x.x.x + $ meson build + +The *meson* script can be given options to change its default behaviour. + +To get the complete list of the options run the following command: + +:: + + $ meson configure + +When you have determined which options you want to use (if any), +continue the process. + +Note the use of **sudo** with the *ninja install* command below. Using +sudo is only required when installing to a location your user does not +have write access to. Installing to a system location is a good example +of this. + +If you are installing to a location that your user *does* have write +access to, then you can instead run the *ninja install* command without +putting **sudo** before it. + +:: + + $ meson build [possible options] + $ ninja -C build + $ sudo ninja -C build install + +At this point you **may** have to run ldconfig or a similar utility to +update your list of installed shared libs. + +Building from a GIT checkout +---------------------------- + +The libvirt build process uses Meson build system. By default when the +``meson`` is run from within a GIT checkout, it will turn on -Werror for +builds. This can be disabled with --werror=false, but this is not +recommended. + +To build & install libvirt to your home directory the following commands +can be run: + +:: + + $ meson build --prefix=$HOME/usr + $ ninja -C build + $ sudo ninja -C build install + +Be aware though, that binaries built with a custom prefix will not +interoperate with OS vendor provided binaries, since the UNIX socket +paths will all be different. To produce a build that is compatible with +normal OS vendor prefixes, use + +:: + + $ meson build -Dsystem=true + $ ninja -C build + + +When doing this for day-to-day development purposes, it is recommended +not to install over the OS vendor provided binaries. Instead simply run +libvirt directly from the source tree. For example to run a privileged +libvirtd instance + +:: + + $ su - + # service libvirtd stop (or systemctl stop libvirtd.service) + # /home/to/your/checkout/build/src/libvirtd + + +It is also possible to run virsh directly from the build tree using the +./run script (which sets some environment variables): + +:: + + $ pwd + /home/to/your/checkout/build + $ ./run ./tools/virsh .... diff --git a/docs/meson.build b/docs/meson.build index c54d033f48..36cf679929 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -36,7 +36,6 @@ docs_html_in_files = [ 'auth', 'bugs', 'cgroups', - 'compiling', 'contact', 'contribute', 'csharp', @@ -111,6 +110,7 @@ docs_rst_files = [ 'ci', 'coding-style', 'committer-guidelines', + 'compiling', 'daemons', 'developer-tooling', 'formatbackup',