summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAnastasia Klimchuk <aklm@flashrom.org>2023-09-26 22:23:06 +1000
committerAnastasia Klimchuk <aklm@chromium.org>2023-10-01 07:03:55 +0000
commitf2a208c22825d97c3af460ddb4540ce6eda4f9bf (patch)
treeaf668143a0e010d425f9b0e68fbe5c05e7c52d5b
parent5234c57e33eedb1fd3329389f77b9696e009de25 (diff)
downloadflashrom-f2a208c22825d97c3af460ddb4540ce6eda4f9bf.tar.gz
flashrom-f2a208c22825d97c3af460ddb4540ce6eda4f9bf.tar.bz2
flashrom-f2a208c22825d97c3af460ddb4540ce6eda4f9bf.zip
doc: Fix formatting for the example of commit message
Example of commit message was formatted with code-block directive which has language argument required or optional depending on the sphinx version. Replace code-block with simpler literal block which never has arguments, and also since the text formatted is not actually a code. Change-Id: If0bc8327e973d9bc9a93eea38c83bfab412fb8f4 Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/78120 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <patrick@coreboot.org> Reviewed-by: Alexander Goncharov <chat@joursoir.net>
-rw-r--r--doc/dev_guide/development_guide.rst4
1 files changed, 1 insertions, 3 deletions
diff --git a/doc/dev_guide/development_guide.rst b/doc/dev_guide/development_guide.rst
index bdbee3750..60c562576 100644
--- a/doc/dev_guide/development_guide.rst
+++ b/doc/dev_guide/development_guide.rst
@@ -51,9 +51,7 @@ on the commit (``git commit -s``).
Commit message
--------------
-Commit messages shall have the following format:
-
-.. code-block::
+Commit messages shall have the following format::
<component>: Short description (up to 72 characters)