adds properly formatted documentation to the tickets page

gitblit-org · Apr 6, 2017 · 2d8ae54 · 2d8ae54
1 parent 406da52
commit 2d8ae54
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/src/main/java/com/gitblit/wicket/GitBlitWebApp.properties b/src/main/java/com/gitblit/wicket/GitBlitWebApp.properties
@@ -559,7 +559,8 @@ gb.requireApprovalDescription = patchsets must be approved before merge button i
 gb.requireScore = require score
 gb.requireScoreDescription = patchsets must be rated this high before merge button is enabled
 gb.writeSignoffCommit = write signoff commit
-gb.writeSignoffCommitDescription = reviewed patchsets will have lines of the form 'value: reviewer name <reviewer email>' added to their merge commit.\nE.g. if set to 'Signed-off-by': 'Signed-off-by: reviewer <reviewer@example.com>'.
+gb.writeSignoffCommitDescription = reviewed patchsets will have lines of the form <em>value: reviewer name &lt;reviewer email&gt;</em> added to their merge commit.\nE.g. if set to <em>Signed-off-by</em>: <code>Signed-off-by: reviewer &lt;reviewer@example.com&gt;</code>. Please see ${commitMessageLink} on the meaning of possible values for this.
+gb.writeSignoffCommitLink = Commit Message Conventions in the Linux Kernel
 gb.topic = topic
 gb.proposalTickets = proposed changes
 gb.bugTickets = bugs

diff --git a/src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.html b/src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.html
@@ -124,6 +124,13 @@ <h4><wicket:message key="gb.ticketSettings"></wicket:message></h4>
 			<div wicket:id="requireApproval"></div>
 			<div wicket:id="requireScore"></div>
 			<div wicket:id="writeSignoffCommit"></div>
+			<div>
+			      <wicket:message key="gb.writeSignoffCommitDescription">
+			      <a target="_new" wicket:id="commitMessageLink">
+				    <wicket:message key="gb.writeSignoffCommitLink"></wicket:message>
+			      </a>
+			      </wicket:message>
+			</div>
 			<div wicket:id="mergeTo"></div>
 			<div wicket:id="mergeType"></div>
 
@@ -202,4 +209,4 @@ <h4><wicket:message key="gb.deleteRepositoryHeader"></wicket:message></h4>
 </body>
 
 </wicket:extend>
-</html>
+</html>
diff --git a/src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.java b/src/main/java/com/gitblit/wicket/pages/EditRepositoryPage.java
@@ -37,6 +37,7 @@
 import org.apache.wicket.markup.html.form.CheckBox;
 import org.apache.wicket.markup.html.form.ChoiceRenderer;
 import org.apache.wicket.markup.html.form.DropDownChoice;
+import org.apache.wicket.markup.html.link.ExternalLink;
 import org.apache.wicket.markup.html.form.Form;
 import org.apache.wicket.markup.html.form.IChoiceRenderer;
 import org.apache.wicket.markup.html.form.TextField;
@@ -94,6 +95,8 @@ public class EditRepositoryPage extends RootSubPage {
 
 	private IModel<String> mailingLists;
 
+	private final static String COMMIT_MESSAGE_LINK = "https://git.wiki.kernel.org/index.php/CommitMessageConventions";
+
 	public EditRepositoryPage() {
 		// create constructor
 		super();
@@ -411,6 +414,8 @@ protected void onSubmit() {
 		// do not let the browser pre-populate these fields
 		form.add(new SimpleAttributeModifier("autocomplete", "off"));
 
+		// adds documentation link for localization
+		form.add(new ExternalLink("commitMessageLink", COMMIT_MESSAGE_LINK));
 
 		//
 		//
@@ -469,7 +474,7 @@ protected void onSubmit() {
 		);
 		form.add(new ChoiceOption<String>("writeSignoffCommit",
 				getString("gb.writeSignoffCommit"),
-				getString("gb.writeSignoffCommitDescription"),
+				new String(),
 				new PropertyModel<String>(repositoryModel, "writeSignoffCommit"),
 				signoffCommitMsgs));
 		form.add(new ChoiceOption<String>("mergeTo",