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>
This commit is contained in:
parent
654d7b5e0b
commit
81cd0b0aab
|
@ -130,8 +130,9 @@ The first line of your commit message is your commit summary. This is a brief
|
||||||
one-line description of what you changed in the files using the template
|
one-line description of what you changed in the files using the template
|
||||||
below:
|
below:
|
||||||
|
|
||||||
<filepath>: Short description
|
`<filepath>: Short description`
|
||||||
*ex. cpu/amd/pi/00630F01: Fix checkpatch warnings and errors*
|
*ex. cpu/amd/pi/00630F01: Fix checkpatch warnings and errors*
|
||||||
|
|
||||||
**Note:** It is good practice to use present tense in your descriptions
|
**Note:** It is good practice to use present tense in your descriptions
|
||||||
and do not punctuate your summary.
|
and do not punctuate your summary.
|
||||||
|
|
||||||
|
@ -171,8 +172,9 @@ In the textbox labeled "Commit summary" provide a brief one-line
|
||||||
description of what you changed in the files according to the template
|
description of what you changed in the files according to the template
|
||||||
below:
|
below:
|
||||||
|
|
||||||
<filepath>: Short description
|
`<filepath>: Short description`
|
||||||
*ex. cpu/amd/pi/00630F01: Fix checkpatch warnings and errors*
|
*ex. cpu/amd/pi/00630F01: Fix checkpatch warnings and errors*
|
||||||
|
|
||||||
**Note:** It is good practice to use present tense in your descriptions
|
**Note:** It is good practice to use present tense in your descriptions
|
||||||
and do not punctuate your short description.
|
and do not punctuate your short description.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue