Page Menu
Home
Phorge
Search
Configure Global Search
Log In
Files
F2895422
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Award Token
Flag For Later
Advanced/Developer...
View Handle
View Hovercard
Size
2 KB
Referenced Files
None
Subscribers
None
View Options
diff --git a/.divinerconfig b/.divinerconfig
index 068a92e3..11a99d8c 100644
--- a/.divinerconfig
+++ b/.divinerconfig
@@ -1,8 +1,9 @@
{
"name" : "Arcanist",
"src_base" : "https://github.com/facebook/arcanist/blob/master",
"groups" : {
-
+ "intro" : "Introduction",
+ "config" : "Setup & Configuration"
}
}
diff --git a/src/docs/overview.diviner b/src/docs/overview.diviner
index d8b95877..0bc22578 100644
--- a/src/docs/overview.diviner
+++ b/src/docs/overview.diviner
@@ -1,30 +1,31 @@
@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.
A detailed command reference is available by running ##arc help##.
= Overview =
Arcanist is the command-line interface to Differential, and supports some
related revision control operations. Arcanist allows you to do things like:
- send your code to Differential for review with ##arc diff##
- commit reviewed changes with ##arc commit## (svn) or ##arc amend## (git)
- check your code for syntax and style errors with ##arc lint##
- run unit tests that cover your changes with ##arc unit##
- export changes from Differential or the working copy with ##arc export##
- apply patches from Differential or patchfiles with ##arc patch##
- execute context-aware blame with ##arc cover##
- show Differential status with ##arc list##
In general, these workflows are agnostic to the underlying version control
system and will work properly in git or svn repositories.
= Configuring a New Project =
Create a .arcconfig file.
= SVN Basics =
diff --git a/src/docs/svn_hooks.diviner b/src/docs/svn_hooks.diviner
new file mode 100644
index 00000000..c01fe283
--- /dev/null
+++ b/src/docs/svn_hooks.diviner
@@ -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.
+
File Metadata
Details
Attached
Mime Type
text/x-diff
Expires
Jan 19 2025, 21:27 (6 w, 1 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1128925
Default Alt Text
(2 KB)
Attached To
Mode
rARC Arcanist
Attached
Detach File
Event Timeline
Log In to Comment