Patrick Georgi has submitted this change and it was merged. ( https://review.coreboot.org/c/coreboot/+/32146 )
Change subject: Documentation: Fix invisible text ......................................................................
Documentation: Fix invisible text
Encapsulate angled brackets in backticks '<filepath>' to make text visible in html rendering.
Change-Id: I1ab926956c909aa3cd2fd92068ccb7b800dd1d4a Signed-off-by: Philipp Bartsch phil@grmr.de Reviewed-on: https://review.coreboot.org/c/coreboot/+/32146 Reviewed-by: Paul Menzel paulepanter@users.sourceforge.net Reviewed-by: Patrick Georgi pgeorgi@google.com Tested-by: build bot (Jenkins) no-reply@coreboot.org --- M Documentation/lessons/lesson2.md 1 file changed, 4 insertions(+), 2 deletions(-)
Approvals: build bot (Jenkins): Verified Patrick Georgi: Looks good to me, approved Paul Menzel: Looks good to me, but someone else must approve
diff --git a/Documentation/lessons/lesson2.md b/Documentation/lessons/lesson2.md index c9c9484..d6f800c 100644 --- a/Documentation/lessons/lesson2.md +++ b/Documentation/lessons/lesson2.md @@ -130,8 +130,9 @@ one-line description of what you changed in the files using the template below:
-<filepath>: Short description +`<filepath>: Short description` *ex. cpu/amd/pi/00630F01: Fix checkpatch warnings and errors* + **Note:** It is good practice to use present tense in your descriptions and do not punctuate your summary.
@@ -171,8 +172,9 @@ description of what you changed in the files according to the template below:
-<filepath>: Short description +`<filepath>: Short description` *ex. cpu/amd/pi/00630F01: Fix checkpatch warnings and errors* + **Note:** It is good practice to use present tense in your descriptions and do not punctuate your short description.