Add details to the relnotes for submodule-timeouts

When reading the release notes, there is no context to which patch
and files were changed. This makes it difficult for the reader to
know what "submodule-timeouts" refers to. Improve the release notes
to mention which macros and templates were changed.

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

diff --git a/releasenotes/notes/submodule-timeout-e75d10f51ca36933.yaml b/releasenotes/notes/submodule-timeout-e75d10f51ca36933.yaml
index f13ee74..fca18f8 100644 (file)
--- a/releasenotes/notes/submodule-timeout-e75d10f51ca36933.yaml
+++ b/releasenotes/notes/submodule-timeout-e75d10f51ca36933.yaml
@@ -1,12 +1,16 @@
 ---
 features:
   - |
-    Add a new ``submodule-timeout`` optional parameter to provide a timeout
-    value (in minutes) for timeout operations.
+    **lf-infra-gerrit-scm** and **lf-infra-github-scm** now require a
+    ``submodule-timeout`` parameter to provide a timeout value (in minutes)
+    for git fetch operations.
+  - |
+    All job-templates now provide an optional ``submodule-timeout`` parameter
+    for git fetch operations, defaulting to 10 minutes.
 
 upgrade:
   - |
-    Any project using the lf-infra-gerrit-scm and lf-infra-github-scm macros
-    in our out of global-jjb should need to add a submodule-timeout value.
-    It is recommended to set this value to ``10`` since that is the default
-    value used by the Jenkins Git Plugin.
+    Any project using the **lf-infra-gerrit-scm** and **lf-infra-github-scm**
+    macros in global-jjb should need to add a ``submodule-timeout`` value. It
+    is recommended to default this value to ``10`` since it is the
+    default used by the Jenkins Git Plugin.