You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by ma...@apache.org on 2015/07/29 14:56:34 UTC
svn commit: r1693254 - /nifi/site/trunk/quickstart.html
Author: markap14
Date: Wed Jul 29 12:56:34 2015
New Revision: 1693254
URL: http://svn.apache.org/r1693254
Log:
NIFI-794: indicate that we need to set git.autocrlf in the getting started guide
Modified:
nifi/site/trunk/quickstart.html
Modified: nifi/site/trunk/quickstart.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/quickstart.html?rev=1693254&r1=1693253&r2=1693254&view=diff
==============================================================================
--- nifi/site/trunk/quickstart.html (original)
+++ nifi/site/trunk/quickstart.html Wed Jul 29 12:56:34 2015
@@ -102,12 +102,23 @@
<h2 id="issue-tracking">Issue Tracking</h2>
<p>Track issues on the "NIFI" Project on the Apache Jira (<a href="https://issues.apache.org/jira/browse/NIFI">browse</a>).</p>
<h2 id="building">Building</h2>
+<h4 id="configure-your-git-client">Configure your git client</h4>
+<p>We recommend running the following git config commands in order to ensure
+that git checks out the repository in a consistent manner. These changes
+are particularly important if running on Windows, as the git client has
+trouble with long filenames otherwise. Additionally, in Windows, the
+default behavior of the git client, when installed, is to set the
+<code>core.autocrlf</code> configuration option to <code>true</code>, which can cause some of
+the unit tests to fail.</p>
+<pre><code>git config --global core.longpaths true
+git config --global core.autocrlf false</code></pre>
<h4 id="checking-out-from-git">Checking out from Git</h4>
<p>To check out the code:</p>
<pre><code>git clone http://git-wip-us.apache.org/repos/asf/nifi.git</code></pre>
<p><br/>
Then checkout the 'develop' branch</p>
-<pre><code>git checkout develop</code></pre>
+<pre><code>cd nifi/
+git checkout develop</code></pre>
<p><br/></p>
<h3 id="linux-operating-system-configuration">Linux Operating System Configuration</h3>
<p><em>NOTE</em>: If you are building on Linux, consider these best practices. Typical Linux defaults are not necessarily well tuned for the needs of an IO intensive application like NiFi.