mirror of
https://we.phorge.it/source/phorge.git
synced 2024-12-19 03:50:54 +01:00
Remove pre-commit hook documentation
Summary: Ref T7674. This functionality has been removed. Test Plan: Eyeball it. Reviewers: epriestley, #blessed_reviewers Reviewed By: epriestley, #blessed_reviewers Subscribers: Korvin, epriestley Maniphest Tasks: T7674 Differential Revision: https://secure.phabricator.com/D12713
This commit is contained in:
parent
e225998fce
commit
57c8dc2cff
2 changed files with 0 additions and 43 deletions
|
@ -66,8 +66,6 @@ Arcanist has some advanced features as well, you can:
|
|||
- execute Conduit method calls with ##arc call-conduit##
|
||||
- create or update libphutil libraries with ##arc liberate##
|
||||
- activate tab completion with ##arc shell-complete##
|
||||
- install arc as a pre-commit hook with ##arc svn-hook-pre-commit## or
|
||||
##arc git-hook-pre-receive##
|
||||
- ...or extend Arcanist and add new commands.
|
||||
|
||||
Except where otherwise noted, these workflows are generally agnostic to the
|
||||
|
|
|
@ -1,41 +0,0 @@
|
|||
@title Arcanist User Guide: Repository Hooks
|
||||
@group userguide
|
||||
|
||||
Describes how to set up Arcanist as an SVN pre-commit hook.
|
||||
|
||||
NOTE: This whole thing might be a little shaky and take a touch of finesse.
|
||||
|
||||
= 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
|
||||
set -e # Exit with an error code if this fails.
|
||||
/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 to PHP
|
||||
since SVN nukes ENV before executing scripts. Alternatively you can specify
|
||||
PATH explicitly.
|
||||
|
||||
If your project is configured to run linters or lint engines which aren't part
|
||||
of Arcanist, specify where to load them from with ##--load-phutil-library##:
|
||||
|
||||
--load-phutil-library=/path/to/library/root
|
||||
|
||||
Since SVN commit hooks run without access to a working copy, you'll need to keep
|
||||
one checked out somewhere and reference it with ##--load-phutil-library## if you
|
||||
build new linters or customize lint engines. For example, your hook might
|
||||
look like this:
|
||||
|
||||
#!/bin/sh
|
||||
set -e # Exit with an error code if this fails.
|
||||
/usr/local/bin/php -f /path/to/arcanist/bin/arc svn-hook-pre-commit \
|
||||
--load-phutil-library=/path/to/custom/lint/engine \
|
||||
--load-phutil-library=/path/to/custom/unittest/engine \
|
||||
$@ 1>&2
|
Loading…
Reference in a new issue