From 660dd744136bf335851fcbfd834fb147ab6d2890 Mon Sep 17 00:00:00 2001 From: epriestley Date: Tue, 14 Jun 2011 22:01:17 -0700 Subject: [PATCH] Include a link to documentation when throwing an error from arcanist about a bad 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 --- src/workflow/diff/ArcanistDiffWorkflow.php | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/workflow/diff/ArcanistDiffWorkflow.php b/src/workflow/diff/ArcanistDiffWorkflow.php index 25ff3d33..f4dc2bba 100644 --- a/src/workflow/diff/ArcanistDiffWorkflow.php +++ b/src/workflow/diff/ArcanistDiffWorkflow.php @@ -915,11 +915,15 @@ EOTEXT "problems:\n\n".$desc."\n\nIf you only want to create a diff ". "(not a revision), use --preview to ignore commit messages."); } else if (count($problems) == 1) { + $user_guide = 'http://phabricator.com/docs/phabricator/'. + 'article/Arcanist_User_Guide.html'; throw new ArcanistUsageException( "Commit message is not properly formatted:\n\n".$desc."\n\n". "You should use the standard git commit template to provide 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"); } }