From c13b64653f71be3b3cf4f1fb52ce3b3dba487204 Mon Sep 17 00:00:00 2001 From: Mark Waite Date: Sat, 11 Jul 2020 16:32:50 -0600 Subject: [PATCH] [JENKINS-9346] - Fix token macro help formatting https://issues.jenkins-ci.org/browse/JENKINS-9346 reports that the git plugin token macro help formatting is incorrect. It was using an unnecessary heading to prefix the description of token macro parameters. Other plugins use a definition list to describe the token macro parameters without the unnecessary heading. Do the same for the git plugin. --- .../git/GitBranchTokenMacro/help.jelly | 30 +++++++++---------- .../git/GitRevisionTokenMacro/help.jelly | 20 ++++++------- 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/src/main/resources/hudson/plugins/git/GitBranchTokenMacro/help.jelly b/src/main/resources/hudson/plugins/git/GitBranchTokenMacro/help.jelly index b481cce052..16cfe1fdc3 100644 --- a/src/main/resources/hudson/plugins/git/GitBranchTokenMacro/help.jelly +++ b/src/main/resources/hudson/plugins/git/GitBranchTokenMacro/help.jelly @@ -3,19 +3,19 @@
$${GIT_BRANCH}
Expands to the name of the branch that was built. -
-

Parameters

-
-
all
-
- If specified, all the branches that point to the given commit is listed. - By default, the token expands to just one of them. -
-
fullName
-
- If specified, this token expands to the full branch name, such as 'origin/master'. - Otherwise, it only expands to the short name, such as 'master'. -
-
- \ No newline at end of file +
+
all
+
+ If specified, all the branches that point to the given commit are listed. + By default, the token expands to just one of them. +
+
fullName
+
+ If specified, this token expands to the full branch name, such as 'origin/master'. + Otherwise, it only expands to the short name, such as 'master'. +
+
+ + + diff --git a/src/main/resources/hudson/plugins/git/GitRevisionTokenMacro/help.jelly b/src/main/resources/hudson/plugins/git/GitRevisionTokenMacro/help.jelly index 3cf65c65da..75ac3c6433 100644 --- a/src/main/resources/hudson/plugins/git/GitRevisionTokenMacro/help.jelly +++ b/src/main/resources/hudson/plugins/git/GitRevisionTokenMacro/help.jelly @@ -3,14 +3,14 @@
$${GIT_REVISION}
Expands to the Git SHA1 commit ID that points to the commit that was built. -
-

Parameters

-
-
length=N (optional, default to 40)
-
- Specify the commit ID length. Full SHA1 commit ID is 40 character long, but it is common - to cut it off at 8 or 12 as that often provide enough uniqueness and is a lot more legible. -
-
- \ No newline at end of file +
+
length=N (optional, default to 40)
+
+ Specify the commit ID length. Full SHA1 commit ID is 40 characters long, but it is common + to truncate it at 8 or 12 as that usually provide enough uniqueness and is more legible. +
+
+ + +