Source

VersionControl_Hg / src / Documentation / API / Docbook / versioncontrol / hg / executable / versioncontrol-hg-executable / setexecutable.xml

The default branch has multiple heads

<refentry id="package.versioncontrol.hg.executable.versioncontrol-hg-executable.setexecutable">
 <refnamediv>
  <refname>
   <function>VersionControl_Hg_Executable::setExecutable</function>
  </refname>
  <refpurpose>
   Validates the existance and viability of the Mercurial executable on  the
   system
</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <funcsynopsis>
   <funcsynopsisinfo>require_once &apos;/Hg/Executable.php&apos;;</funcsynopsisinfo>
   <funcprototype>
    <funcdef>
     void
     <function>VersionControl_Hg_Executable::setExecutable</function>
    </funcdef>
    <paramdef>
     string
     <parameter>
      <optional>$path = &null;</optional>
     </parameter>
    </paramdef>
   </funcprototype>
  </funcsynopsis>
 </refsynopsisdiv>
 <refsect1 id="package.versioncontrol.hg.executable.versioncontrol-hg-executable.setexecutable.desc">
  &title.desc;
  <para>If you need to specifiy a particular Hg executable to use, then pass  the full path to Mercurial as a paramter of this function.</para>
  <para>
   Usage:
   <programlisting role="php">
<![CDATA[$hg->setExecutable('/path/to/hg');]]>
   </programlisting>
   A failed reset/change will not clear the previously set executable.
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.executable.versioncontrol-hg-executable.setexecutable.param">
  &title.param;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      &type.string;
      <parameter>$path</parameter>
     </term>
     <listitem>
      <para>The path to the hg executable</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.executable.versioncontrol-hg-executable.setexecutable.throws">
  &title.throws;
  <para>
   <emphasis>throws</emphasis>
   VersionControl_Hg_Executable_Exception
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.executable.versioncontrol-hg-executable.setexecutable.note">
  &title.note;
  &note.notstatic;
</refsect1>
</refentry>