revi-archive/phorge-arcanist
1
0
Fork 0
mirror of https://we.phorge.it/source/arcanist.git synced 2024-11-29 02:02:40 +01:00
Code Issues Releases Wiki Activity

Include a link to documentation when throwing an error from arcanist about a bad

Browse source 
commit template

Summary:
When users run into this, point them at the documentation explicitly.

Test Plan:
Tried to "arc diff" with a commit message of 'derp', got a live link to
documentation instead of a vague set of general instructions.

Reviewed By: aran
Reviewers: moskov, aran, jungejason, tuomaspelkonen
CC: aran
Differential Revision: 468
This commit is contained in:
epriestley 2011-06-14 22:01:17 -07:00
parent 1c865c7827
commit 660dd74413
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/workflow/diff/ArcanistDiffWorkflow.php
View file

@ -915,11 +915,15 @@ EOTEXT
"problems:\n\n".$desc."\n\nIf you only want to create a diff ". "problems:\n\n".$desc."\n\nIf you only want to create a diff ".
"(not a revision), use --preview to ignore commit messages."); "(not a revision), use --preview to ignore commit messages.");
} else if (count($problems) == 1) { } else if (count($problems) == 1) {
$user_guide = 'http://phabricator.com/docs/phabricator/'.
'article/Arcanist_User_Guide.html';
throw new ArcanistUsageException( throw new ArcanistUsageException(
"Commit message is not properly formatted:\n\n".$desc."\n\n". "Commit message is not properly formatted:\n\n".$desc."\n\n".
"You should use the standard git commit template to provide a ". "You should use the standard git commit template to provide a ".
"commit message. If you only want to create a diff (not a ". "commit message. If you only want to create a diff (not a ".
"revision), use --preview to ignore commit messages."); "revision), use --preview to ignore commit messages.\n\n".
"See this document for instructions on configuring the commit ".
"template:\n\n {$user_guide}\n");
} }
} }