coreboot-gerrit October 2018

coreboot-gerrit@coreboot.org

1 participants
1285 discussions

Change in coreboot[master]: vboot: fix CONFIG_RESUME_PATH_SAME_AS_BOOT S3 resume logic
by Philipp Deppenwiese (Code Review) 22 Oct '18

22 Oct '18

Philipp Deppenwiese has posted comments on this change. ( https://review.coreboot.org/29060 ) Change subject: vboot: fix CONFIG_RESUME_PATH_SAME_AS_BOOT S3 resume logic ...................................................................... Patch Set 5: Sorry Aaron. Did the review during vacation. :) Now I am back. I am talking about src/soc/intel/fsp_baytrail . It has vboot support as well. -- To view, visit https://review.coreboot.org/29060 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-MessageType: comment Gerrit-Change-Id: I1ef0bcdfd01746198f8140f49698b58065d820b9 Gerrit-Change-Number: 29060 Gerrit-PatchSet: 5 Gerrit-Owner: Joel Kitching <kitching(a)google.com> Gerrit-Reviewer: Aaron Durbin <adurbin(a)chromium.org> Gerrit-Reviewer: Furquan Shaikh <furquan(a)google.com> Gerrit-Reviewer: Joel Kitching <kitching(a)google.com> Gerrit-Reviewer: Julius Werner <jwerner(a)chromium.org> Gerrit-Reviewer: Paul Menzel <paulepanter(a)users.sourceforge.net> Gerrit-Reviewer: Philipp Deppenwiese <zaolin.daisuki(a)gmail.com> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Comment-Date: Mon, 22 Oct 2018 12:06:46 +0000 Gerrit-HasComments: No Gerrit-HasLabels: No

1 0

Change in coreboot[master]: Documentation: Fix markdown inline code
by Philipp Deppenwiese (Code Review) 22 Oct '18

22 Oct '18

Philipp Deppenwiese has submitted this change and it was merged. ( https://review.coreboot.org/29206 ) Change subject: Documentation: Fix markdown inline code ...................................................................... Documentation: Fix markdown inline code recommonmark doesn't know about inline code, while all other software generating documentation is able to handle it. Add support for inline code by adding a wrapper class around the recommonmark parser that converts code to docutils literal blocks. Fixes invisible inline code in current documentation. Change-Id: I0269d15a685ed0c0241be8c8acfade0e58363845 Signed-off-by: Patrick Rudolph <siro(a)das-labor.org> Reviewed-on: https://review.coreboot.org/29206 Tested-by: build bot (Jenkins) <no-reply(a)coreboot.org> Reviewed-by: Paul Menzel <paulepanter(a)users.sourceforge.net> Reviewed-by: Jonathan Neuschäfer <j.neuschaefer(a)gmx.net> Reviewed-by: Philipp Deppenwiese <zaolin.daisuki(a)gmail.com> --- M Documentation/conf.py 1 file changed, 11 insertions(+), 5 deletions(-) Approvals: build bot (Jenkins): Verified Paul Menzel: Looks good to me, but someone else must approve Philipp Deppenwiese: Looks good to me, approved Jonathan Neuschäfer: Looks good to me, but someone else must approve diff --git a/Documentation/conf.py b/Documentation/conf.py index 07868fa..85df9ea 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -1,5 +1,6 @@ # -*- coding: utf-8 -*- import subprocess +from recommonmark.parser import CommonMarkParser # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -156,9 +157,14 @@ 'Miscellaneous'), ] -source_parsers = { - '.md': 'recommonmark.parser.CommonMarkParser', -} +enable_auto_toc_tree = True + +class MyCommonMarkParser(CommonMarkParser): + # remove this hack once upsteam RecommonMark supports inline code + def visit_code(self, mdnode): + from docutils import nodes + n = nodes.literal(mdnode.literal, mdnode.literal) + self.current_node.append(n) # Documents to append as an appendix to all manuals. # @@ -176,11 +182,11 @@ # # texinfo_no_detailmenu = False -enable_auto_toc_tree = True - def setup(app): from recommonmark.transform import AutoStructify + app.add_source_parser('.md', MyCommonMarkParser) + app.add_config_value('recommonmark_config', { 'enable_auto_toc_tree': True, 'enable_auto_doc_ref': False, # broken in Sphinx 1.6+ -- To view, visit https://review.coreboot.org/29206 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: I0269d15a685ed0c0241be8c8acfade0e58363845 Gerrit-Change-Number: 29206 Gerrit-PatchSet: 2 Gerrit-Owner: Patrick Rudolph <siro(a)das-labor.org> Gerrit-Reviewer: Angel Pons <th3fanbus(a)gmail.com> Gerrit-Reviewer: Jonathan Neuschäfer <j.neuschaefer(a)gmx.net> Gerrit-Reviewer: Patrick Georgi <pgeorgi(a)google.com> Gerrit-Reviewer: Patrick Rudolph <siro(a)das-labor.org> Gerrit-Reviewer: Paul Menzel <paulepanter(a)users.sourceforge.net> Gerrit-Reviewer: Philipp Deppenwiese <zaolin.daisuki(a)gmail.com> Gerrit-Reviewer: Tom Hiller <thrilleratplay(a)gmail.com> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>

1 0

Change in coreboot[master]: Documentation: Fix markdown inline code
by Philipp Deppenwiese (Code Review) 22 Oct '18

22 Oct '18

Philipp Deppenwiese has posted comments on this change. ( https://review.coreboot.org/29206 ) Change subject: Documentation: Fix markdown inline code ...................................................................... Patch Set 1: Code-Review+2 -- To view, visit https://review.coreboot.org/29206 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-MessageType: comment Gerrit-Change-Id: I0269d15a685ed0c0241be8c8acfade0e58363845 Gerrit-Change-Number: 29206 Gerrit-PatchSet: 1 Gerrit-Owner: Patrick Rudolph <siro(a)das-labor.org> Gerrit-Reviewer: Angel Pons <th3fanbus(a)gmail.com> Gerrit-Reviewer: Jonathan Neuschäfer <j.neuschaefer(a)gmx.net> Gerrit-Reviewer: Patrick Georgi <pgeorgi(a)google.com> Gerrit-Reviewer: Patrick Rudolph <siro(a)das-labor.org> Gerrit-Reviewer: Paul Menzel <paulepanter(a)users.sourceforge.net> Gerrit-Reviewer: Philipp Deppenwiese <zaolin.daisuki(a)gmail.com> Gerrit-Reviewer: Tom Hiller <thrilleratplay(a)gmail.com> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Comment-Date: Mon, 22 Oct 2018 12:02:27 +0000 Gerrit-HasComments: No Gerrit-HasLabels: Yes

1 0

Change in coreboot[master]: Documentation: Fix markdown highlighting
by Philipp Deppenwiese (Code Review) 22 Oct '18

22 Oct '18

Philipp Deppenwiese has submitted this change and it was merged. ( https://review.coreboot.org/29207 ) Change subject: Documentation: Fix markdown highlighting ...................................................................... Documentation: Fix markdown highlighting Fix some code blocks that use invalid Markdown syntax. Change-Id: I8cfe63b2c21ae93923f88bbf7ef4cfb8dccdb5ef Signed-off-by: Patrick Rudolph <siro(a)das-labor.org> Reviewed-on: https://review.coreboot.org/29207 Tested-by: build bot (Jenkins) <no-reply(a)coreboot.org> Reviewed-by: Paul Menzel <paulepanter(a)users.sourceforge.net> Reviewed-by: Philipp Deppenwiese <zaolin.daisuki(a)gmail.com> --- M Documentation/soc/cavium/cn81xx/index.md M Documentation/vendorcode/cavium/bdk.md 2 files changed, 5 insertions(+), 5 deletions(-) Approvals: build bot (Jenkins): Verified Paul Menzel: Looks good to me, but someone else must approve Philipp Deppenwiese: Looks good to me, approved diff --git a/Documentation/soc/cavium/cn81xx/index.md b/Documentation/soc/cavium/cn81xx/index.md index 69fe710..3063b94 100644 --- a/Documentation/soc/cavium/cn81xx/index.md +++ b/Documentation/soc/cavium/cn81xx/index.md @@ -41,8 +41,8 @@ are unlocked and the contents are flushed to DRAM. Locked cachelines are never evicted. -The CAR setup is done in '''bootblock_custom.S''' and thus doesn't use the common -aarch64 '''bootblock.S''' code. +The CAR setup is done in `bootblock_custom.S` and thus doesn't use the common +aarch64 `bootblock.S` code. ## DRAM setup diff --git a/Documentation/vendorcode/cavium/bdk.md b/Documentation/vendorcode/cavium/bdk.md index 5763ece..5f6721f 100644 --- a/Documentation/vendorcode/cavium/bdk.md +++ b/Documentation/vendorcode/cavium/bdk.md @@ -1,7 +1,7 @@ # Cavium's BDK ## BDK -A part of Cavium's BDK can be found in '''src/vendorcode/cavium/bdk'''. +A part of Cavium's BDK can be found in `src/vendorcode/cavium/bdk`. It does the **DRAM init** in romstage and the **PCIe**, **QLM**, **SLI**, **PHY**, **BGX**, **SATA** init in ramstage. @@ -11,9 +11,9 @@ for implementation details), where the key and the value are stored as strings. The key-value pairs must be advertised in romstage and ramstage using the -'''bdk_config_set_fdt()''' method. +`bdk_config_set_fdt()` method. -The tool '''util/cavium/devicetree_convert.py''' can be used to convert a +The tool `util/cavium/devicetree_convert.py` can be used to convert a devicetree to a key-value array. ## Modifications -- To view, visit https://review.coreboot.org/29207 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: I8cfe63b2c21ae93923f88bbf7ef4cfb8dccdb5ef Gerrit-Change-Number: 29207 Gerrit-PatchSet: 2 Gerrit-Owner: Patrick Rudolph <siro(a)das-labor.org> Gerrit-Reviewer: Paul Menzel <paulepanter(a)users.sourceforge.net> Gerrit-Reviewer: Philipp Deppenwiese <zaolin.daisuki(a)gmail.com> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>

1 0

Change in coreboot[master]: Documentation: Fix markdown highlighting
by Philipp Deppenwiese (Code Review) 22 Oct '18

22 Oct '18

Philipp Deppenwiese has posted comments on this change. ( https://review.coreboot.org/29207 ) Change subject: Documentation: Fix markdown highlighting ...................................................................... Patch Set 1: Code-Review+2 -- To view, visit https://review.coreboot.org/29207 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-MessageType: comment Gerrit-Change-Id: I8cfe63b2c21ae93923f88bbf7ef4cfb8dccdb5ef Gerrit-Change-Number: 29207 Gerrit-PatchSet: 1 Gerrit-Owner: Patrick Rudolph <siro(a)das-labor.org> Gerrit-Reviewer: Paul Menzel <paulepanter(a)users.sourceforge.net> Gerrit-Reviewer: Philipp Deppenwiese <zaolin.daisuki(a)gmail.com> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-Comment-Date: Mon, 22 Oct 2018 12:02:13 +0000 Gerrit-HasComments: No Gerrit-HasLabels: Yes

1 0

Change in coreboot[master]: commonlib/region: Add region protect API
by build bot (Jenkins) (Code Review) 22 Oct '18

22 Oct '18

build bot (Jenkins) has posted comments on this change. ( https://review.coreboot.org/28724 ) Change subject: commonlib/region: Add region protect API ...................................................................... Patch Set 5: (1 comment) https://review.coreboot.org/#/c/28724/5/src/commonlib/include/commonlib/reg… File src/commonlib/include/commonlib/region.h: https://review.coreboot.org/#/c/28724/5/src/commonlib/include/commonlib/reg… PS5, Line 97: int (*protect)(const struct region *); function definition argument 'const struct region *' should also have an identifier name -- To view, visit https://review.coreboot.org/28724 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-MessageType: comment Gerrit-Change-Id: I4c9376e2c2c7a4852f13c65824c6cd64a1c6ac0a Gerrit-Change-Number: 28724 Gerrit-PatchSet: 5 Gerrit-Owner: Rizwan Qureshi <rizwan.qureshi(a)intel.com> Gerrit-Reviewer: Aaron Durbin <adurbin(a)chromium.org> Gerrit-Reviewer: Furquan Shaikh <furquan(a)google.com> Gerrit-Reviewer: Patrick Georgi <pgeorgi(a)google.com> Gerrit-Reviewer: Patrick Rudolph <siro(a)das-labor.org> Gerrit-Reviewer: Paul Menzel <paulepanter(a)users.sourceforge.net> Gerrit-Reviewer: Rizwan Qureshi <rizwan.qureshi(a)intel.com> Gerrit-Reviewer: Subrata Banik <subrata.banik(a)intel.com> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org> Gerrit-CC: Arthur Heymans <arthur(a)aheymans.xyz> Gerrit-Comment-Date: Mon, 22 Oct 2018 11:48:56 +0000 Gerrit-HasComments: Yes Gerrit-HasLabels: No

1 0

Change in coreboot[master]: mb/lenovo/*/romstage: Use macros instead of magic numbers
by Peter Lemenkov (Code Review) 22 Oct '18

22 Oct '18

Hello build bot (Jenkins), I'd like you to reexamine a change. Please visit https://review.coreboot.org/29208 to look at the new patch set (#2). Change subject: mb/lenovo/*/romstage: Use macros instead of magic numbers ...................................................................... mb/lenovo/*/romstage: Use macros instead of magic numbers Apparently coreboot still uses magic numbers instead of macros in some Lenovo mainboards. Let's use macros instead. Please, take a look at the following diff: /* Set up I/O Trap #0 for 0xfe00 (SMIC) */ RCBA32(0x1e84) = 0x00020001; - RCBA32(0x1e80) = 0x0000fe01; + RCBA32(IOTR0) = 0x0000fe01; IOTR[0123] is a 64-bit width variable. Unfortunately, we don't have RCBA64 macro yet so we have to use two RCBA32's here. lemenkov ~/work/coreboot (git::master): grep -R IOTR0 src/southbridge/ src/southbridge/intel/i82801gx/i82801gx.h:#define IOTR0 0x1e80 /* 64bit */ src/southbridge/intel/ibexpeak/pch.h:#define IOTR0 0x1e80 /* 64bit */ src/southbridge/intel/bd82x6x/pch.h:#define IOTR0 0x1e80 /* 64bit */ src/southbridge/intel/fsp_bd82x6x/pch.h:#define IOTR0 0x1e80 /* 64bit */ src/southbridge/intel/lynxpoint/pch.h:#define IOTR0 0x1e80 /* 64bit */ lemenkov ~/work/coreboot (git::master): Change-Id: Icf185c77ede5a258fe37be9e772be6804d014b57 Signed-off-by: Peter Lemenkov <lemenkov(a)gmail.com> --- M src/mainboard/lenovo/t60/romstage.c M src/mainboard/lenovo/x60/romstage.c 2 files changed, 8 insertions(+), 8 deletions(-) git pull ssh://review.coreboot.org:29418/coreboot refs/changes/08/29208/2 -- To view, visit https://review.coreboot.org/29208 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-MessageType: newpatchset Gerrit-Change-Id: Icf185c77ede5a258fe37be9e772be6804d014b57 Gerrit-Change-Number: 29208 Gerrit-PatchSet: 2 Gerrit-Owner: Peter Lemenkov <lemenkov(a)gmail.com> Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>

1 0

Change in coreboot[master]: mb/lenovo/*/romstage: Use macros instead of magic numbers
by Peter Lemenkov (Code Review) 22 Oct '18

22 Oct '18

Peter Lemenkov has uploaded this change for review. ( https://review.coreboot.org/29208 Change subject: mb/lenovo/*/romstage: Use macros instead of magic numbers ...................................................................... mb/lenovo/*/romstage: Use macros instead of magic numbers Apparently coreboot still uses magic numbers instead of macros in some Lenovo mainboards. Let's use macros instead. Please, take a look at the following diff: /* Set up I/O Trap #0 for 0xfe00 (SMIC) */ RCBA32(0x1e84) = 0x00020001; - RCBA32(0x1e80) = 0x0000fe01; + RCBA32(IOTR0) = 0x0000fe01; IOTR[0123] is a 64-bit width value. Unfortunately, we don't have RCBA64 macro yet so we have to use two RCBA32's here. lemenkov ~/work/coreboot (git::master): grep -R IOTR0 src/southbridge/ src/southbridge/intel/i82801gx/i82801gx.h:#define IOTR0 0x1e80 /* 64bit */ src/southbridge/intel/ibexpeak/pch.h:#define IOTR0 0x1e80 /* 64bit */ src/southbridge/intel/bd82x6x/pch.h:#define IOTR0 0x1e80 /* 64bit */ src/southbridge/intel/fsp_bd82x6x/pch.h:#define IOTR0 0x1e80 /* 64bit */ src/southbridge/intel/lynxpoint/pch.h:#define IOTR0 0x1e80 /* 64bit */ lemenkov ~/work/coreboot (git::master): Change-Id: Icf185c77ede5a258fe37be9e772be6804d014b57 Signed-off-by: Peter Lemenkov <lemenkov(a)gmail.com> --- M src/mainboard/lenovo/t60/romstage.c M src/mainboard/lenovo/x60/romstage.c 2 files changed, 8 insertions(+), 8 deletions(-) git pull ssh://review.coreboot.org:29418/coreboot refs/changes/08/29208/1 diff --git a/src/mainboard/lenovo/t60/romstage.c b/src/mainboard/lenovo/t60/romstage.c index e4a8efb..9d3cab9 100644 --- a/src/mainboard/lenovo/t60/romstage.c +++ b/src/mainboard/lenovo/t60/romstage.c @@ -76,8 +76,8 @@ static void rcba_config(void) { /* Set up virtual channel 0 */ - RCBA32(0x0014) = 0x80000001; - RCBA32(0x001c) = 0x03128010; + RCBA32(V0CTL) = 0x80000001; + RCBA32(V1CAP) = 0x03128010; /* Device 1f interrupt pin register */ RCBA32(D31IP) = 0x00001230; @@ -104,11 +104,11 @@ /* Set up I/O Trap #0 for 0xfe00 (SMIC) */ RCBA32(0x1e84) = 0x00020001; - RCBA32(0x1e80) = 0x0000fe01; + RCBA32(IOTR0) = 0x0000fe01; /* Set up I/O Trap #3 for 0x800-0x80c (Trap) */ RCBA32(0x1e9c) = 0x000200f0; - RCBA32(0x1e98) = 0x000c0801; + RCBA32(IOTR3) = 0x000c0801; } static void early_ich7_init(void) diff --git a/src/mainboard/lenovo/x60/romstage.c b/src/mainboard/lenovo/x60/romstage.c index 81ee5da..229975b 100644 --- a/src/mainboard/lenovo/x60/romstage.c +++ b/src/mainboard/lenovo/x60/romstage.c @@ -75,8 +75,8 @@ static void rcba_config(void) { /* Set up virtual channel 0 */ - RCBA32(0x0014) = 0x80000001; - RCBA32(0x001c) = 0x03128010; + RCBA32(V0CTL) = 0x80000001; + RCBA32(V1CAP) = 0x03128010; /* Device 1f interrupt pin register */ RCBA32(D31IP) = 0x00001230; @@ -103,11 +103,11 @@ /* Set up I/O Trap #0 for 0xfe00 (SMIC) */ RCBA32(0x1e84) = 0x00020001; - RCBA32(0x1e80) = 0x0000fe01; + RCBA32(IOTR0) = 0x0000fe01; /* Set up I/O Trap #3 for 0x800-0x80c (Trap) */ RCBA32(0x1e9c) = 0x000200f0; - RCBA32(0x1e98) = 0x000c0801; + RCBA32(IOTR3) = 0x000c0801; } static void early_ich7_init(void) -- To view, visit https://review.coreboot.org/29208 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-MessageType: newchange Gerrit-Change-Id: Icf185c77ede5a258fe37be9e772be6804d014b57 Gerrit-Change-Number: 29208 Gerrit-PatchSet: 1 Gerrit-Owner: Peter Lemenkov <lemenkov(a)gmail.com>

1 0

Change in coreboot[master]: Documentation: Fix markdown highlighting
by Patrick Rudolph (Code Review) 22 Oct '18

22 Oct '18

Patrick Rudolph has uploaded this change for review. ( https://review.coreboot.org/29207 Change subject: Documentation: Fix markdown highlighting ...................................................................... Documentation: Fix markdown highlighting Fix some code blocks that use invalid Markdown syntax. Change-Id: I8cfe63b2c21ae93923f88bbf7ef4cfb8dccdb5ef Signed-off-by: Patrick Rudolph <siro(a)das-labor.org> --- M Documentation/soc/cavium/cn81xx/index.md M Documentation/vendorcode/cavium/bdk.md 2 files changed, 5 insertions(+), 5 deletions(-) git pull ssh://review.coreboot.org:29418/coreboot refs/changes/07/29207/1 diff --git a/Documentation/soc/cavium/cn81xx/index.md b/Documentation/soc/cavium/cn81xx/index.md index 69fe710..3063b94 100644 --- a/Documentation/soc/cavium/cn81xx/index.md +++ b/Documentation/soc/cavium/cn81xx/index.md @@ -41,8 +41,8 @@ are unlocked and the contents are flushed to DRAM. Locked cachelines are never evicted. -The CAR setup is done in '''bootblock_custom.S''' and thus doesn't use the common -aarch64 '''bootblock.S''' code. +The CAR setup is done in `bootblock_custom.S` and thus doesn't use the common +aarch64 `bootblock.S` code. ## DRAM setup diff --git a/Documentation/vendorcode/cavium/bdk.md b/Documentation/vendorcode/cavium/bdk.md index 5763ece..5f6721f 100644 --- a/Documentation/vendorcode/cavium/bdk.md +++ b/Documentation/vendorcode/cavium/bdk.md @@ -1,7 +1,7 @@ # Cavium's BDK ## BDK -A part of Cavium's BDK can be found in '''src/vendorcode/cavium/bdk'''. +A part of Cavium's BDK can be found in `src/vendorcode/cavium/bdk`. It does the **DRAM init** in romstage and the **PCIe**, **QLM**, **SLI**, **PHY**, **BGX**, **SATA** init in ramstage. @@ -11,9 +11,9 @@ for implementation details), where the key and the value are stored as strings. The key-value pairs must be advertised in romstage and ramstage using the -'''bdk_config_set_fdt()''' method. +`bdk_config_set_fdt()` method. -The tool '''util/cavium/devicetree_convert.py''' can be used to convert a +The tool `util/cavium/devicetree_convert.py` can be used to convert a devicetree to a key-value array. ## Modifications -- To view, visit https://review.coreboot.org/29207 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-MessageType: newchange Gerrit-Change-Id: I8cfe63b2c21ae93923f88bbf7ef4cfb8dccdb5ef Gerrit-Change-Number: 29207 Gerrit-PatchSet: 1 Gerrit-Owner: Patrick Rudolph <siro(a)das-labor.org>

1 0

Change in coreboot[master]: Documentation: Fix markdown inline code
by Patrick Rudolph (Code Review) 22 Oct '18

22 Oct '18

Patrick Rudolph has uploaded this change for review. ( https://review.coreboot.org/29206 Change subject: Documentation: Fix markdown inline code ...................................................................... Documentation: Fix markdown inline code recommonmark doesn't know about inline code, while all other software generating documentation is able to handle it. Add support for inline code by adding a wrapper class around the recommonmark parser that converts code to docutils literal blocks. Fixes invisible inline code in current documentation. Change-Id: I0269d15a685ed0c0241be8c8acfade0e58363845 Signed-off-by: Patrick Rudolph <siro(a)das-labor.org> --- M Documentation/conf.py 1 file changed, 11 insertions(+), 5 deletions(-) git pull ssh://review.coreboot.org:29418/coreboot refs/changes/06/29206/1 diff --git a/Documentation/conf.py b/Documentation/conf.py index 07868fa..85df9ea 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -1,5 +1,6 @@ # -*- coding: utf-8 -*- import subprocess +from recommonmark.parser import CommonMarkParser # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -156,9 +157,14 @@ 'Miscellaneous'), ] -source_parsers = { - '.md': 'recommonmark.parser.CommonMarkParser', -} +enable_auto_toc_tree = True + +class MyCommonMarkParser(CommonMarkParser): + # remove this hack once upsteam RecommonMark supports inline code + def visit_code(self, mdnode): + from docutils import nodes + n = nodes.literal(mdnode.literal, mdnode.literal) + self.current_node.append(n) # Documents to append as an appendix to all manuals. # @@ -176,11 +182,11 @@ # # texinfo_no_detailmenu = False -enable_auto_toc_tree = True - def setup(app): from recommonmark.transform import AutoStructify + app.add_source_parser('.md', MyCommonMarkParser) + app.add_config_value('recommonmark_config', { 'enable_auto_toc_tree': True, 'enable_auto_doc_ref': False, # broken in Sphinx 1.6+ -- To view, visit https://review.coreboot.org/29206 To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings Gerrit-Project: coreboot Gerrit-Branch: master Gerrit-MessageType: newchange Gerrit-Change-Id: I0269d15a685ed0c0241be8c8acfade0e58363845 Gerrit-Change-Number: 29206 Gerrit-PatchSet: 1 Gerrit-Owner: Patrick Rudolph <siro(a)das-labor.org>

1 0

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

coreboot-gerrit October 2018