Browse Source

Merge pull request #9384 from JamesDeFabia/449TortoiseGit

IDE-449 Document TortoiseGit integration

Reviewed-By: Gordon Smith <gordon.smith@lexisnexis.com>
Reviewed-By: Richard Chapman <rchapman@hpccsystems.com>
Richard Chapman 8 years ago
parent
commit
8933864ca7

+ 55 - 1
docs/HPCCClientTools/CT_Mods/CT_ECL_IDE.xml

@@ -2248,7 +2248,9 @@
 
           <para>Right-click in the <emphasis role="bold">Repository Window
           </emphasis>for a Pop-up menu containing options which are available
-          depending on whether you have a folder or ECL file selected.</para>
+          depending on whether you have a folder or ECL file selected. Note,
+          if you have TortoiseGit installed, the menu is extended. See <link
+          linkend="versioncontrol">Version Control</link> for details</para>
 
           <informaltable colsep="1" frame="all" rowsep="1">
             <tgroup cols="2">
@@ -3264,6 +3266,58 @@ ENDMACRO;
         <para><graphic fileref="../../images/CT54.jpg" /></para>
       </sect2>
 
+      <sect2 id="versioncontrol">
+        <title>Version Control</title>
+
+        <para>The ECL IDE does not directly provide version control
+        functionality, but it does support integration with the TortoiseGit
+        Window Shell Interface to Git version control. This open-source
+        toolset provides easy access to Git commands from Windows Explorer.
+        The IDE's integration extends that to the context menu of the
+        Repository toolbox in the IDE.</para>
+
+        <para></para>
+
+        <orderedlist>
+          <listitem>
+            <para>Install and configure TortoiseGit
+            (www.tortoisegit.org)</para>
+
+            <para>Follow the instructions on their site.</para>
+          </listitem>
+
+          <listitem>
+            <para>Clone a Git repository to a folder on your local
+            machine.</para>
+
+            <para>Follow the instructions in your Git repository's
+            site.</para>
+          </listitem>
+
+          <listitem>
+            <para>Add that folder to the list of ECL Folders on the <emphasis
+            role="bold">Compiler</emphasis> tab of the <emphasis
+            role="bold">Preferences</emphasis> dialog.</para>
+
+            <para><graphic fileref="../../images/IDE_eclfolders.jpg" /></para>
+          </listitem>
+
+          <listitem>
+            <para>Press the <emphasis role="bold">Ok</emphasis> button.</para>
+
+            <para>The folder now appears in your Repository toolbox.</para>
+          </listitem>
+
+          <listitem>
+            <para>Right-click on the folder in the Repository toolbox, and
+            choose your Git command from the TortoiseGit menu.</para>
+
+            <para><graphic
+            fileref="../../images/IDE_tortoisegit.jpg" /></para>
+          </listitem>
+        </orderedlist>
+      </sect2>
+
       <sect2 id="Graph_Viewer" role="brk">
         <title><emphasis>Graph Viewer </emphasis></title>
 

BIN
docs/images/IDE_eclfolders.jpg


BIN
docs/images/IDE_tortoisegit.jpg