summaryrefslogtreecommitdiffstats
path: root/docs/submittingpatches.html
diff options
context:
space:
mode:
authorDylan Baker <[email protected]>2018-12-20 09:28:56 -0800
committerDylan Baker <[email protected]>2018-12-21 17:43:56 +0000
commit1e872d14865fbe8dddf41b57b79137305144ead1 (patch)
tree21f7d355ec31e94bd176014e28cd5ce86b260ddc /docs/submittingpatches.html
parent516160d717b81141a65a03060ac440a1cad8ae94 (diff)
docs: add note about using backticks for rbs in gitlab
So that gitlab will render the < and > correctly allowing the tag to be copy-n-pasted without additional formatting. Reviewed-by: Eric Anholt <[email protected]> Reviewed-by: Jordan Justen <[email protected]>
Diffstat (limited to 'docs/submittingpatches.html')
-rw-r--r--docs/submittingpatches.html11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/submittingpatches.html b/docs/submittingpatches.html
index 61c6d1f8806..736cbd64de8 100644
--- a/docs/submittingpatches.html
+++ b/docs/submittingpatches.html
@@ -303,6 +303,17 @@ into commits in a MR before it is merged.
</p>
<p>
+When providing a Reviewed-by, Acked-by, or Tested-by tag in a gitlab MR,
+enclose the tag in backticks:
+</p>
+<pre>
+ `Reviewed-by: Joe Hacker &lt;[email protected]&gt;`</pre>
+<p>
+This is the markdown format for literal, and will prevent gitlab from hiding
+the &lt; and &gt; symbols.
+</p>
+
+<p>
Review by non-experts is encouraged. Understanding how someone else
goes about solving a problem is a great way to learn your way around
the project. The submitter is expected to evaluate whether they have