NiFI-794: Updated Getting Started guide with information about git configuration

This commit is contained in:
Mark Payne 2015-07-29 09:12:04 -04:00
parent c541728e0f
commit fba3c3705f
1 changed files with 16 additions and 0 deletions

View File

@ -15,6 +15,21 @@ Track issues on the "NIFI" Project on the Apache Jira ([browse][jira]).
## Building
#### Configure your git client
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
`core.autocrlf` configuration option to `true`, which can cause some of
the unit tests to fail.
```
git config --global core.longpaths true
git config --global core.autocrlf false
```
#### Checking out from Git
To check out the code:
@ -26,6 +41,7 @@ git clone http://git-wip-us.apache.org/repos/asf/nifi.git
Then checkout the 'develop' branch
```
cd nifi/
git checkout develop
```
<br/>