diff options
| author | Dylan Baker <dylan@pnwbakers.com> | 2018-12-20 09:28:56 -0800 |
|---|---|---|
| committer | Dylan Baker <dylan@pnwbakers.com> | 2018-12-21 17:43:56 +0000 |
| commit | 1e872d14865fbe8dddf41b57b79137305144ead1 (patch) | |
| tree | 21f7d355ec31e94bd176014e28cd5ce86b260ddc /docs | |
| parent | 516160d717b81141a65a03060ac440a1cad8ae94 (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 <eric@anholt.net>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/submittingpatches.html | 11 |
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 <jhacker@example.com>`</pre> +<p> +This is the markdown format for literal, and will prevent gitlab from hiding +the < and > 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 |