Anastasia Klimchuk submitted this change.

View Change

Approvals: Patrick Georgi: Looks good to me, but someone else must approve Alexander Goncharov: Looks good to me, approved build bot (Jenkins): Verified
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>
---
M doc/dev_guide/development_guide.rst
1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/doc/dev_guide/development_guide.rst b/doc/dev_guide/development_guide.rst
index bdbee37..60c5625 100644
--- a/doc/dev_guide/development_guide.rst
+++ b/doc/dev_guide/development_guide.rst
@@ -51,9 +51,7 @@
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)


To view, visit change 78120. To unsubscribe, or for help writing mail filters, visit settings.

Gerrit-Project: flashrom
Gerrit-Branch: main
Gerrit-Change-Id: If0bc8327e973d9bc9a93eea38c83bfab412fb8f4
Gerrit-Change-Number: 78120
Gerrit-PatchSet: 2
Gerrit-Owner: Anastasia Klimchuk <aklm@chromium.org>
Gerrit-Reviewer: Alexander Goncharov <chat@joursoir.net>
Gerrit-Reviewer: Anastasia Klimchuk <aklm@chromium.org>
Gerrit-Reviewer: Patrick Georgi <patrick@coreboot.org>
Gerrit-Reviewer: Peter Marheine <pmarheine@chromium.org>
Gerrit-Reviewer: Thomas Heijligen <src@posteo.de>
Gerrit-Reviewer: build bot (Jenkins) <no-reply@coreboot.org>
Gerrit-MessageType: merged