1
0
Fork 0
mirror of https://we.phorge.it/source/arcanist.git synced 2024-11-10 00:42:40 +01:00

Inch toward a defensibly documented project state.

Summary:

Test Plan:

Reviewers:

CC:
This commit is contained in:
epriestley 2011-02-15 15:10:53 -08:00
parent ca98fc175f
commit 026269a707
3 changed files with 22 additions and 1 deletions

View file

@ -2,7 +2,8 @@
"name" : "Arcanist",
"src_base" : "https://github.com/facebook/arcanist/blob/master",
"groups" : {
"intro" : "Introduction",
"config" : "Setup & Configuration"
}
}

View file

@ -1,4 +1,5 @@
@title Arcanist Overview
@group intro
This document provides an overview of Arcanist, a code workflow tool. Arcanist
(commonly, "arc") is the command-line frontend to Differential.

View file

@ -0,0 +1,19 @@
@title Installing Arcanist SVN Hooks
@group config
= Installing Arcanist SVN Hooks =
You can install Arcanist as an SVN pre-commit hook, to reject commits which
contain lint errors. The immediate value of this is that syntax errors won't
be committable, but you can block other kinds of badness with appropriate lint
engines.
To install Arcanist as a pre-commit hook, add this to your svn/hooks/pre-commit:
#!/bin/sh
/path/to/arcanist/bin/arc svn-hook-pre-commit $@ 1>&2
Make sure you make this file executable, or you'll get an error for every commit
with an unhelpful error message. You also need to specify the full path since
SVN nukes ENV before executing scripts.