External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 21:55:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add libvirt-php information page

Browse Source 
This adds a ibvirt-php information page with some
basic information on libvirt-php project compilation, contribution
and other useful information.
This commit is contained in:
Michal Novotny 2011-02-09 09:43:09 +08:00 committed by Daniel Veillard
parent ab2def20ff
commit d0ae594885
3 changed files with 96 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/bindings.html.in
View File

@ -27,16 +27,17 @@
</li>
<li>
<p>
<strong>PHP</strong>: Radek Hladik develops
<a href="http://phplibvirt.cybersales.cz/">PHP bindings</a>.
<strong>PHP</strong>: Radek Hladik started developing
<a href="http://phplibvirt.cybersales.cz/">PHP bindings</a> in 2010.
</p>
<p>
The php-libvirt bindings also have their source online
<a href="http://github.com/Kedarius/php-libvirt">here in Github</a>.
In February 2011 the binding development has been moved to the
<a href="http://libvirt.org/git/?p=libvirt-php.git;a=summary">libvirt.org as libvirt-php project</a>.
</p>
<p>
This allows you to easily see the code, make comments on it,
create your own forks, and contribute the changes back.
The project is now maintained by Michal Novotny and it's heavily based
on Radek's version. For more information including the information on posting
the patches you to libvirt-php please refer to <a href="php.html">PHP binding page</a>.
</p>
</li>
<li>

85
docs/php.html.in Normal file
View File

@ -0,0 +1,85 @@
<?xml version="1.0"?>
<html>
<body>
<h1>PHP API bindings</h1>
<h2>Presentation</h2>
<p>The libvirt-php, originally called php-libvirt, is the PHP API bindings for
the libvirt virtualization toolkit originally developed by Radek Hladik but
currently maintained by Red Hat.</p>
<h2>Getting the source</h2>
<p> The PHP bindings code source is now maintained in a <a
href="http://git-scm.com/">git</a> repository available on
<a href="http://libvirt.org/git/">libvirt.org</a>:
</p>
<pre>
git clone git://libvirt.org/libvirt-php.git
</pre>
<p>
It can also be browsed at
</p>
<pre>
<a href="http://libvirt.org/git/?p=libvirt-php.git;a=summary">http://libvirt.org/git/?p=libvirt-php.git;a=summary</a>
</pre>
<p></p>
<h2>Building</h2>
<p>The code is using autotools to generate the files necessary for compilation. The preferred way of building is
to run autogen.sh to generate configure script and then go on with the standard linux make commands, i.e.</p>
<pre>
$ cd libvirt-php
$ ./autogen.sh
$ make
</pre>
<h2>Enabling the module in PHP</h2>
<p>Before you start using the module you have to install the module first. The module
php_libvirt.so is being generated when you compile it. This is necessary to be loaded
in the extensions sections of php.ini file for PHP version older than PHP-5.</p>
<p>
Starting with PHP-5 you can create a file called libvirt.ini in /etc/php.d having just
one line <code>extension=php_libvirt.so</code> to enable the extension. Of course, you
need to have this module copied in the directory with the rest of your PHP modules to
make PHP find the module for you.</p>
<p>
If you're using PHP as a module (mod_php5.so) in the Apache webserver you need to
restart your Apache to trigger configuration reload for PHP.
</p>
<p>
If you're not sure that you have everything set up right and you don't want to restart
your Apache webserver before you're sure everything will be working fine you could try
running the test using cli-based PHP interpreter. There are some example scripts coming
along the source codes in the <code>example</code> subdirectory so you can try to run
php on the index.php script to check whether it's working fine to establish connection or not.
</p>
<p>
When you're having some issues with the connection make sure the apache user is having
access to libvirt. For more information please see <a href="auth.html">Libvirt access control</a> page.
</p>
<h2>Contribution</h2>
<p>
If you would like to contribute to the libvirt-php project you could write patches for it but please
make sure you're following the procedure below:
<ol>
<li>Sign up to libvirt list if you're not on it yet (libvir-list@redhat.com)</li>
<li>Clone the repository from libvirt.org site using:
<pre>git clone git://libvirt.org/libvirt-php</pre>
</li>
<li>Set your git username and e-mail and also set the subject prefix in the project's repository using:
<pre>git config --local format.subjectprefix "libvirt-php"</pre>
</li>
<li>Create the patch in the form of the commits and include also information about usage (example source codes maybe) and testing</li>
<li>Format it using <code>git format-patch -X</code> where X is the number of patch parts to be posted, for multipart patch (X is greater than 1) please use also numbering (-n) option and include the cover-letter (--cover-letter).</li>
<li>Send to libvir-list@redhat.com using the <code>git send-email &lt;files&gt; --to libvir-list@redhat.com</code> command where &lt;files&gt; can be <i>000*</i> to send all the patches formatted by git format-patch since git format-patch names the files starting with the 4 digit numbers.</li>
</ol>
When you send the patch you're patch will be reviewed and later committed to the libvirt-php repository. You'll be contacted in case some flaws are found during the review.
</p>
</body>
</html>

4
docs/sitemap.html.in
View File

@ -266,6 +266,10 @@
<a href="csharp.html">C#</a>
<span>overview of the C# API bindings</span>
</li>
<li>
<a href="php.html">PHP</a>
<span>overview of the PHP API bindings</span>
</li>
</ul>
</li>
<li>