Source

VersionControl_Hg / Trunk / Documentation / API / Docbook / versioncontrol / hg / command / versioncontrol-hg-command-archive / revision.xml

The default branch has multiple heads

<refentry id="package.versioncontrol.hg.command.versioncontrol-hg-command-archive.revision">
 <refnamediv>
  <refname>
   <function>VersionControl_Hg_Command_Archive::revision</function>
  </refname>
  <refpurpose>Specified the revision to restrict the archive operation to</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <funcsynopsis>
   <funcsynopsisinfo>require_once &apos;/Hg/Command/Archive.php&apos;;</funcsynopsisinfo>
   <funcprototype>
    <funcdef>
     void
     <function>VersionControl_Hg_Command_Archive::revision</function>
    </funcdef>
    <paramdef>
     string
     <parameter>
      <optional>$revision = &apos;tip&apos;</optional>
     </parameter>
    </paramdef>
   </funcprototype>
  </funcsynopsis>
 </refsynopsisdiv>
 <refsect1 id="package.versioncontrol.hg.command.versioncontrol-hg-command-archive.revision.desc">
  &title.desc;
  <para>
   Usage:
   <programlisting role="php">
<![CDATA[$hg->archive()->revision(7)->run();]]>
   </programlisting>
   or
   <programlisting role="php">
<![CDATA[$hg->archive(array('revision' => 7 ))->to('path/to)->run();]]>
   </programlisting>
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.command.versioncontrol-hg-command-archive.revision.param">
  &title.param;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      &type.string;
      <parameter>$revision</parameter>
     </term>
     <listitem>
      <para>is the optional revision to archive</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.command.versioncontrol-hg-command-archive.revision.throws">
  &title.throws;
  <para>
   <emphasis>throws</emphasis>
   no exceptions thrown
  </para>
 </refsect1>
 <refsect1 id="package.versioncontrol.hg.command.versioncontrol-hg-command-archive.revision.note">
  &title.note;
  &note.notstatic;
</refsect1>
</refentry>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.