Source

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

The default branch has multiple heads

<refentry id="package.versioncontrol.hg.executable.versioncontrol-hg-executable.--construct">
 <refnamediv>
  <refname>
   constructor
   <function>VersionControl_Hg_Executable::__construct</function>
  </refname>
  <refpurpose>Constructor</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <funcsynopsis>
   <funcsynopsisinfo>require_once &apos;/Hg/Executable.php&apos;;</funcsynopsisinfo>
   <funcprototype>
    <funcdef>
     void      constructor
     <function>VersionControl_Hg_Executable::__construct</function>
    </funcdef>
    <paramdef>
     VersionControl_Hg
     <parameter>$hg</parameter>
    </paramdef>
    <paramdef>
     string
     <parameter>$path</parameter>
    </paramdef>
   </funcprototype>
  </funcsynopsis>
 </refsynopsisdiv>
 <refsect1 id="package.versioncontrol.hg.executable.versioncontrol-hg-executable.--construct.desc">
  &title.desc;
  <para>Finds and sets the system&apos;s existing Mercurial executable binary which  with all future operations will use.</para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.executable.versioncontrol-hg-executable.--construct.param">
  &title.param;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <type>VersionControl_Hg</type>
      <parameter>$hg</parameter>
     </term>
     <listitem>
      <para>The root object</para>
     </listitem>
    </varlistentry>
   </variablelist>
   <variablelist>
    <varlistentry>
     <term>
      &type.string;
      <parameter>$path</parameter>
     </term>
     <listitem>
      <para>
       The full path to the user defined
       executable
</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.executable.versioncontrol-hg-executable.--construct.throws">
  &title.throws;
  <para>
   <emphasis>throws</emphasis>
   no exceptions thrown
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.executable.versioncontrol-hg-executable.--construct.note">
  &title.note;
  &note.notstatic;
</refsect1>
</refentry>