From 1e872d14865fbe8dddf41b57b79137305144ead1 Mon Sep 17 00:00:00 2001
From: Dylan Baker
Date: Thu, 20 Dec 2018 09:28:56 -0800
Subject: [PATCH] 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
Reviewed-by: Jordan Justen
---
docs/submittingpatches.html | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/docs/submittingpatches.html b/docs/submittingpatches.html
index 61c6d1f..736cbd6 100644
--- a/docs/submittingpatches.html
+++ b/docs/submittingpatches.html
@@ -303,6 +303,17 @@ into commits in a MR before it is merged.
+When providing a Reviewed-by, Acked-by, or Tested-by tag in a gitlab MR,
+enclose the tag in backticks:
+
+
+ `Reviewed-by: Joe Hacker <jhacker@example.com>`
+
+This is the markdown format for literal, and will prevent gitlab from hiding
+the < and > symbols.
+
+
+
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
--
2.7.4