xdiff-file-diff.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b8758b0605e80c4e3610137b7502a6abeea5c69b Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.xdiff-file-diff" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xdiff_file_diff</refname>
  <refpurpose>Créé un diff unifié entre deux fichiers</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xdiff_file_diff</methodname>
   <methodparam><type>string</type><parameter>old_file</parameter></methodparam>
   <methodparam><type>string</type><parameter>new_file</parameter></methodparam>
   <methodparam><type>string</type><parameter>dest</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>context</parameter><initializer>3</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>minimal</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Crée un diff unifié contenant les différences entre le fichier
   <parameter>old_file</parameter> et <parameter>new_file</parameter> et les
   enregistre dans le fichier <parameter>dest</parameter>. Le fichier résultant
   est humainement lisible. Le paramètre optionnel <parameter>context</parameter>
   spécifie le nombre de lignes du contexte qui doit être ajouté autour de
   chaque modification. Si le paramètre
   <parameter>minimal</parameter> vaut &true;, alors le fichier de sortie sera
   le plus petit possible (peut prendre beaucoup de temps). 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>old_file</parameter></term>
     <listitem>
      <para>
       Chemin vers le premier fichier. Ce fichier représente l'ancien fichier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>new_file</parameter></term>
     <listitem>
      <para>
       Chemin vers le second fichier. Ce fichier représente le nouveau fichier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dest</parameter></term>
     <listitem>
      <para>
       Chemin vers le fichier contenant la différence.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      <para>
       Indique le nombre de lignes de contexte que vous voulez inclure dans
       le résultat de diff.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>minimal</parameter></term>
     <listitem>
      <para>
       Configurez <parameter>minimal</parameter> à &true; si vous voulez
       minimaliser la taille du fichier des différences (peut prendre beaucoup
       de temps).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>xdiff_file_diff</function></title>
    <para>
     Le code suivant crée un diff de deux fichiers php avec une longueur de
     contexte de 2.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$old_version = 'my_script.php';
$new_version = 'my_new_script.php';

xdiff_file_diff($old_version, $new_version, 'my_script.diff', 2);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Cette fonction ne fonctionne pas correctement avec les fichiers binaires.
    Pour effectuer un diff sur des fichiers binaires, utilisez la fonction
    <function>xdiff_file_bdiff</function>/<function>xdiff_file_rabdiff</function>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>xdiff_file_patch</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->