From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Thu, 7 Mar 2019 03:50:08 +0000 (-0500)
Subject: Document required params in lf-maven-stage macro
X-Git-Tag: v0.34.0~7^2
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=42170b43a1dd1c6ccc3db5b7f2aeaaba7701ffb3;p=releng%2Fglobal-jjb.git

Document required params in lf-maven-stage macro

Change-Id: I1f281b22f7b9454ef58e3fcc5fa49c5d333263a7
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
---

diff --git a/docs/jjb/lf-maven-jobs.rst b/docs/jjb/lf-maven-jobs.rst
index aca0f5f6..d4e3370c 100644
--- a/docs/jjb/lf-maven-jobs.rst
+++ b/docs/jjb/lf-maven-jobs.rst
@@ -66,6 +66,12 @@ lf-maven-stage
 
 Calls the maven stage script to push artifacts to a Nexus staging repository.
 
+:Required Parameters:
+
+    :mvn-global-settings: The name of the Maven global settings to use for
+        Maven configuration.
+    :mvn-settings: The name of settings file containing credentials for the project.
+
 lf-update-java-alternatives
 ---------------------------