[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: [libvirt] [PATCHv2] docs: added compiling page and significantly expanded windows page



On 21/12/2010, at 3:49 AM, Eric Blake wrote:
<snip>
>> +    <pre>
>> +      ./configure [possible options]
>> +      make
>> +      make install</pre>
> 
> Maybe list the last line as:
> 
> [sudo] make install
> 
> to help point out that installation is the only part of the process that
> must be run as root when doing a system-wide install, but that root
> rights are not needed when installing somewhere under $HOME for a single
> user?

Fixed all the nits you mentioned, and pushed the result.  When updating for this
one though, rewrote some of the content for better clarity instead.  Appending
here (but happy to change if needed, etc):

+    <h2><a name="compiling">Compiling a release tarball</a></h2>
+
+    <p>
+      libvirt uses the standard configure/make/install steps:
+    </p>
+
+    <pre>
+      $ gunzip -c libvirt-x.x.x.tar.gz | tar xvf -
+      $ cd libvirt-x.x.x
+      $ ./configure</pre>
+
+    <p>
+      The <i>configure</i> script can be given options to change its default
+      behaviour.
+    </p>
+
+    <p>
+      To get the complete list of the options it can take, pass it the
+      <i>--help</i> option like this:
+    </p>
+
+    <pre>
+      $ ./configure <i>--help</i></pre>
+
+    <p>
+      When you have determined which options you want to use (if any),
+      continue the process.
+    </p>
+
+    <p>
+      Note the use of <b>sudo</b> with the <i>make install</i> 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.
+    </p>
+
+    <p>
+      If you are installing to a location that your user <i>does</i> have write
+      access to, then you can instead run the <i>make install</i> command
+      without putting <b>sudo</b> before it.
+    </p>
+
+    <pre>
+      $ ./configure <i>[possible options]</i>
+      $ make
+      $ <b>sudo</b> <i>make install</i></pre>
+
+    <p>
+      At this point you <b>may</b> have to run ldconfig or a similar utility
+      to update your list of installed shared libs.
+    </p>
+
+    <h2><a name="building">Building from a GIT checkout</a></h2>
+
+    <p>
+      The libvirt build process uses GNU autotools, so after obtaining a
+      checkout it is necessary to generate the configure script and Makefile.in
+      templates using the <code>autogen.sh</code> command, passing the extra
+      arguments as for configure. As an example, to do a complete build and
+      install it into your home directory run:
+    </p>
+
+    <pre>
+      $ ./autogen.sh --prefix=$HOME/usr --enable-compile-warnings=error
+      $ make
+      $ <b>sudo</b> make install</pre>

Hmmm, there's more change there than I realised.  Possibly should have made a
v3 instead, but oh well. ;)


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]