Skip to content

Commit 49efe6a

Browse files
committed
Set up Arcanist
Summary: Set up arcanist and clang Test Plan: Doing this is the test Reviewers: jhabibi Reviewed By: jhabibi Subscribers: brookea Tags: #zorp Differential Revision: http://phabricator.purduesigbots.com/D13
1 parent 7efc3d6 commit 49efe6a

File tree

5 files changed

+537
-0
lines changed

5 files changed

+537
-0
lines changed

.arcconfig

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"phabricator.uri": "https://phabricator.purduesigbots.com/",
3+
"repoistory.callsign": "rRESTRICTEDPROS",
4+
"lint.engine": "ArcanistConfigurationDrivenLintEngine",
5+
"default-reviewers": "berman5 jhabibi jbuschjr",
6+
"load": [
7+
"clang-format-linter"
8+
]
9+
}

.arclint

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"linters": {
3+
"clang-format": {
4+
"type": "clang-format",
5+
"include": "(.*\\.c$)"
6+
}
7+
}
8+
}

.clang-format

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
BasedOnStyle: LLVM
2+
IndentWidth: 8
3+
UseTab: ForIndentation
4+
BreakBeforeBraces: Linux
5+
AllowShortIfStatementsOnASingleLine: false
6+
IndentCaseLabels: false
7+
DerivePointerAlignment: false
8+
PointerAlignment: Left
9+
Standard: Cpp11
10+

README.md

+22
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,25 @@ The PROS kernel has the following features:
1111
* Shell, a console for interacting with the microcontroller in real-time and provides real-time scripting capabilities
1212

1313
More documentation soon :)
14+
15+
## Using Arcanist
16+
If on Windows, I highly recommend using Bash on Windows to set up Arcanist. It will likely be much less of a headache.
17+
18+
1. Install php and clang-format (`sudo apt install php clang-format`)
19+
2. Download arcanist and libphutil into a directory you won't delete... `~` will probably suffice for Bash on Windows
20+
```
21+
git clone https://github.com/phacility/libphutil.git
22+
git clone https://github.com/phacility/arcanist.git
23+
```
24+
3. Add arcanist to PATH by appending to `~/.bashrc` or `~/.zshrc` or similar file
25+
```
26+
export PATH="$PATH:/somewhere/arcanist/bin"
27+
```
28+
Be sure to source the file after editing it by running `source ~/.bashrc`
29+
4. Configure Conduit keys by running `arc install-certificate`
30+
31+
32+
To propose changes, edit files as you normally would, then when ready to push/merge into master:
33+
1. Complete merge/commit locally
34+
2. Run `arc diff`
35+

0 commit comments

Comments
 (0)