Attention is currently required from: Arthur Heymans, Jérémy Compostella, Patrick Rudolph, Paul Menzel.
Shuo Liu has posted comments on this change by Patrick Rudolph. ( https://review.coreboot.org/c/coreboot/+/85789?usp=email )
The change is no longer submittable: All-Comments-Resolved is unsatisfied now.
Change subject: cpu/x86/64bit/mode_switch: Work around FSP bug
......................................................................
Patch Set 3:
(1 comment)
File src/cpu/x86/64bit/mode_switch.S:
https://review.coreboot.org/c/coreboot/+/85789/comment/156b9503_5d13f8f1?us… :
PS3, Line 50: lidt -16(%ebp)
should it be lidt (%ebp)? (per ln22-27)
--
To view, visit https://review.coreboot.org/c/coreboot/+/85789?usp=email
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email
Gerrit-MessageType: comment
Gerrit-Project: coreboot
Gerrit-Branch: main
Gerrit-Change-Id: I56367d8153aa10a9b1bcaa5ffde8ebe202e8c00c
Gerrit-Change-Number: 85789
Gerrit-PatchSet: 3
Gerrit-Owner: Patrick Rudolph <patrick.rudolph(a)9elements.com>
Gerrit-Reviewer: Arthur Heymans <arthur(a)aheymans.xyz>
Gerrit-Reviewer: Jérémy Compostella <jeremy.compostella(a)intel.com>
Gerrit-Reviewer: Maximilian Brune <maximilian.brune(a)9elements.com>
Gerrit-Reviewer: Paul Menzel <paulepanter(a)mailbox.org>
Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>
Gerrit-CC: Shuo Liu <shuo.liu(a)intel.com>
Gerrit-Attention: Patrick Rudolph <patrick.rudolph(a)9elements.com>
Gerrit-Attention: Jérémy Compostella <jeremy.compostella(a)intel.com>
Gerrit-Attention: Paul Menzel <paulepanter(a)mailbox.org>
Gerrit-Attention: Arthur Heymans <arthur(a)aheymans.xyz>
Gerrit-Comment-Date: Mon, 06 Jan 2025 01:28:17 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Attention is currently required from: Maximilian Brune, Philipp Hug, ron minnich.
Nicholas Chin has posted comments on this change by Maximilian Brune. ( https://review.coreboot.org/c/coreboot/+/85852?usp=email )
Change subject: mb/emulation/spike-riscv/uart.c: Update UART address
......................................................................
Patch Set 1: Code-Review+2
(1 comment)
Commit Message:
https://review.coreboot.org/c/coreboot/+/85852/comment/2dacd3ca_6fef2184?us… :
PS1, Line 9: Simualator
Simulator
--
To view, visit https://review.coreboot.org/c/coreboot/+/85852?usp=email
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email
Gerrit-MessageType: comment
Gerrit-Project: coreboot
Gerrit-Branch: main
Gerrit-Change-Id: I0e3db9d8b141c733bf609f906018096e3594ce83
Gerrit-Change-Number: 85852
Gerrit-PatchSet: 1
Gerrit-Owner: Maximilian Brune <maximilian.brune(a)9elements.com>
Gerrit-Reviewer: Nicholas Chin <nic.c3.14(a)gmail.com>
Gerrit-Reviewer: Philipp Hug <philipp(a)hug.cx>
Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>
Gerrit-Reviewer: ron minnich <rminnich(a)gmail.com>
Gerrit-Attention: Philipp Hug <philipp(a)hug.cx>
Gerrit-Attention: Maximilian Brune <maximilian.brune(a)9elements.com>
Gerrit-Attention: ron minnich <rminnich(a)gmail.com>
Gerrit-Comment-Date: Mon, 06 Jan 2025 00:33:14 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: Yes
Nicholas Chin has uploaded a new patch set (#2). ( https://review.coreboot.org/c/coreboot/+/85857?usp=email )
Change subject: docs/getting-started: Update instructions for writing docs
......................................................................
docs/getting-started: Update instructions for writing docs
- Update the instructions for building the documentation to account for
the switch from Recommonmark to MyST Parser
- Update outdated URLs
- Update various details to account for the current behavior and
features resulting from previous changes
Change-Id: I569862e30fb88a421ad2338aafabeaf3ea76836a
Signed-off-by: Nicholas Chin <nic.c3.14(a)gmail.com>
---
M Documentation/getting_started/writing_documentation.md
1 file changed, 32 insertions(+), 40 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/57/85857/2
--
To view, visit https://review.coreboot.org/c/coreboot/+/85857?usp=email
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email
Gerrit-MessageType: newpatchset
Gerrit-Project: coreboot
Gerrit-Branch: main
Gerrit-Change-Id: I569862e30fb88a421ad2338aafabeaf3ea76836a
Gerrit-Change-Number: 85857
Gerrit-PatchSet: 2
Gerrit-Owner: Nicholas Chin <nic.c3.14(a)gmail.com>
Nicholas Chin has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/85857?usp=email )
Change subject: docs/getting-started: Update instructions for writing docs
......................................................................
docs/getting-started: Update instructions for writing docs
- Update the instructions for building the documentation to account for
the switch from Recommonmark to MyST Parser
- Update outdated URLs
- Update various details to account for the current behavior and
features resulting from previous changes
Change-Id: I569862e30fb88a421ad2338aafabeaf3ea76836a
Signed-off-by: Nicholas Chin <nic.c3.14(a)gmail.com>
---
M Documentation/getting_started/writing_documentation.md
1 file changed, 32 insertions(+), 40 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/57/85857/1
diff --git a/Documentation/getting_started/writing_documentation.md b/Documentation/getting_started/writing_documentation.md
index 6b1cf3c..fa350d2 100644
--- a/Documentation/getting_started/writing_documentation.md
+++ b/Documentation/getting_started/writing_documentation.md
@@ -14,18 +14,13 @@
over reStructuredText so only embedded ReST is supported. Checkout the
[Markdown Guide] for more information.
-### option 1: Use the docker image
+### Option 1: Use the docker image
The easiest way to build the documentation is using a docker image.
To build the image run the following in the base directory:
make -C util/docker/ doc.coreboot.org
-Before building the documentation make sure the output directory is given
-the correct permissions before running docker.
-
- mkdir -p Documentation/_build
-
To build the documentation:
make -C util/docker docker-build-docs
@@ -36,30 +31,29 @@
On the host machine, open a browser to the address <http://0.0.0.0:8000>.
-### option 2: Install Sphinx
+### Option 2: Install Sphinx
-Please follow this official [guide] to install sphinx.
-You will also need python-recommonmark for sphinx to be able to handle
-markdown documentation.
+Please follow this official [guide] to install sphinx. You will also need
+myst-parser for sphinx to be able to handle markdown documentation.
Since some Linux distributions don't package every needed sphinx extension,
the installation via pip in a venv is recommended. You'll need these python3
modules:
* sphinx
-* recommonmark
-* sphinx_rtd_theme
+* myst-parser
+* sphinx-rtd-theme
-The following combination of versions has been tested: sphinx 2.3.1,
-recommonmark 0.6.0, and sphinx_rtd_theme 0.4.3.
+The following combination of versions has been tested: sphinx 8.1.3,
+myst-parser 4.0.0, and sphinx-rtd-theme 2.0.0.
Now change into the `Documentation` folder in the coreboot directory and run
this command in there
- make sphinx
+ make
If no error occurs, you can find the generated HTML documentation in
-`Documentation/_build` now.
+`Documentation/_build/html` now.
### Optional
@@ -88,15 +82,17 @@
12. Shouldn't cover implementation details; for details, the code is the
reference.
-## Referencing markdown documents
-
-Starting with Sphinx 1.6 recommonmark's *auto_doc_ref* feature is broken.
-To reference documents use the TOC tree or inline RST code.
-
## Markdown and Tables
-Under Sphinx markdown tables are not supported. Therefore you can use following
-code block to write tables in reStructuredText and embed them into the markdown:
+Markdown tables are supported:
+
+ | Header 1 | Header 2 | Header 3 |
+ |------------|-----------|-----------|
+ | body row 1 | column 2 | column 3 |
+ | body row 2 | column 2 | column 3 |
+
+Tables can also be written using embedded reStructured Text, which has provides
+additional features like merging cells:
```{eval-rst}
+------------+------------+-----------+
@@ -117,22 +113,20 @@
To make sure that all documents are included into the final documentation, you
must reference each document from at least one *toctree*. The *toctree* must
only reference files in the same folder or in subfolders !
-To create a toctree, simply use a bullet list or numbered list with a single
-reference. References in regular text aren't considered as *toctree* .
-This feature is enabled by recommonmark's *enable_auto_toc_tree* .
+To create a toctree, you must use the following syntax to invoke the
+Sphinx toctree directive:
**Example toctree:**
-```
-* [Chapter 1](chapter1.md)
-* [Chapter 2](chapter2.md)
-* [Subchapter](sub/index.md)
-```
+ ```{toctree}
+ :maxdepth: 1
-```
-1. [Chapter 1](chapter1.md)
-2. [Chapter 2](chapter2.md)
-```
+ Chapter 1 <chapter1.md>
+ Chapter 2 <chapter2.md>
+ Subchapter <sub/index.md>
+ ```
+
+References in regular text aren't considered as *toctree* .
If you do only reference the document, but do not include it in any toctree,
you'll see the following warning:
@@ -152,11 +146,9 @@
Of course this can only be done from a markdown file that is included in the
TOC tree.
-[coreboot]: https://coreboot.org
-[Documentation]: https://review.coreboot.org/cgit/coreboot.git/tree/Documentation
-[sphinx-autobuild]: https://github.com/GaretJax/sphinx-autobuild
-[guide]: http://www.sphinx-doc.org/en/stable/install.html
-[Sphinx]: http://www.sphinx-doc.org/en/master/
+[sphinx-autobuild]: https://github.com/sphinx-doc/sphinx-autobuild
+[guide]: https://www.sphinx-doc.org/en/master/usage/installation.html
+[Sphinx]: https://www.sphinx-doc.org/en/master/
[Markdown Guide]: https://www.markdownguide.org/
[Gerrit Guidelines]: ../contributing/gerrit_guidelines.md
[review.coreboot.org]: https://review.coreboot.org
--
To view, visit https://review.coreboot.org/c/coreboot/+/85857?usp=email
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email
Gerrit-MessageType: newchange
Gerrit-Project: coreboot
Gerrit-Branch: main
Gerrit-Change-Id: I569862e30fb88a421ad2338aafabeaf3ea76836a
Gerrit-Change-Number: 85857
Gerrit-PatchSet: 1
Gerrit-Owner: Nicholas Chin <nic.c3.14(a)gmail.com>
Attention is currently required from: Alicja Michalska.
Nicholas Chin has posted comments on this change by Alicja Michalska. ( https://review.coreboot.org/c/coreboot/+/85680?usp=email )
Change subject: Documentation: Add Topton N100 (X2F)
......................................................................
Patch Set 3: Code-Review+2
--
To view, visit https://review.coreboot.org/c/coreboot/+/85680?usp=email
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email
Gerrit-MessageType: comment
Gerrit-Project: coreboot
Gerrit-Branch: main
Gerrit-Change-Id: Id585b064054b338ea8cead6edb6c5153030b9cde
Gerrit-Change-Number: 85680
Gerrit-PatchSet: 3
Gerrit-Owner: Alicja Michalska <ahplka19(a)gmail.com>
Gerrit-Reviewer: Nicholas Chin <nic.c3.14(a)gmail.com>
Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>
Gerrit-Attention: Alicja Michalska <ahplka19(a)gmail.com>
Gerrit-Comment-Date: Sun, 05 Jan 2025 22:49:12 +0000
Gerrit-HasComments: No
Gerrit-Has-Labels: Yes
Attention is currently required from: Alicja Michalska, Nicholas Chin.
Hello Nicholas Chin, build bot (Jenkins),
I'd like you to reexamine a change. Please visit
https://review.coreboot.org/c/coreboot/+/85680?usp=email
to look at the new patch set (#3).
The following approvals got outdated and were removed:
Code-Review+2 by Nicholas Chin, Verified+1 by build bot (Jenkins)
The change is no longer submittable: Code-Review and Verified are unsatisfied now.
Change subject: Documentation: Add Topton N100 (X2F)
......................................................................
Documentation: Add Topton N100 (X2F)
Document the board and how to flash coreboot.
Change-Id: Id585b064054b338ea8cead6edb6c5153030b9cde
Signed-off-by: Alicja Michalska <alicja.michalska(a)9elements.com>
---
M Documentation/mainboard/index.md
A Documentation/mainboard/topton/adl/x2f-n100.md
2 files changed, 108 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/80/85680/3
--
To view, visit https://review.coreboot.org/c/coreboot/+/85680?usp=email
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email
Gerrit-MessageType: newpatchset
Gerrit-Project: coreboot
Gerrit-Branch: main
Gerrit-Change-Id: Id585b064054b338ea8cead6edb6c5153030b9cde
Gerrit-Change-Number: 85680
Gerrit-PatchSet: 3
Gerrit-Owner: Alicja Michalska <ahplka19(a)gmail.com>
Gerrit-Reviewer: Nicholas Chin <nic.c3.14(a)gmail.com>
Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>
Gerrit-Attention: Alicja Michalska <ahplka19(a)gmail.com>
Gerrit-Attention: Nicholas Chin <nic.c3.14(a)gmail.com>
Attention is currently required from: Alicja Michalska.
Nicholas Chin has posted comments on this change by Alicja Michalska. ( https://review.coreboot.org/c/coreboot/+/85680?usp=email )
Change subject: Documentation: Add Topton N100 (X2F)
......................................................................
Patch Set 2:
(1 comment)
File Documentation/mainboard/topton/adl/x2f-n100.md:
https://review.coreboot.org/c/coreboot/+/85680/comment/e5ecaa7b_cbb31958?us… :
PS2, Line 37: Without opening the case and connecting the SPI flasher.
> Yes, I indented it to break from last bullet point and align to the paragraph. […]
Acknowledged
--
To view, visit https://review.coreboot.org/c/coreboot/+/85680?usp=email
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email
Gerrit-MessageType: comment
Gerrit-Project: coreboot
Gerrit-Branch: main
Gerrit-Change-Id: Id585b064054b338ea8cead6edb6c5153030b9cde
Gerrit-Change-Number: 85680
Gerrit-PatchSet: 2
Gerrit-Owner: Alicja Michalska <ahplka19(a)gmail.com>
Gerrit-Reviewer: Nicholas Chin <nic.c3.14(a)gmail.com>
Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>
Gerrit-Attention: Alicja Michalska <ahplka19(a)gmail.com>
Gerrit-Comment-Date: Sun, 05 Jan 2025 22:39:52 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Comment-In-Reply-To: Alicja Michalska <ahplka19(a)gmail.com>
Comment-In-Reply-To: Nicholas Chin <nic.c3.14(a)gmail.com>
Attention is currently required from: Nicholas Chin.
Alicja Michalska has posted comments on this change by Alicja Michalska. ( https://review.coreboot.org/c/coreboot/+/85680?usp=email )
Change subject: Documentation: Add Topton N100 (X2F)
......................................................................
Patch Set 2:
(1 comment)
File Documentation/mainboard/topton/adl/x2f-n100.md:
https://review.coreboot.org/c/coreboot/+/85680/comment/dae71e96_388531e6?us… :
PS2, Line 37: Without opening the case and connecting the SPI flasher.
> Is this indent intentional? Only the extra newline is necessary to make this appear on a separate li […]
Yes, I indented it to break from last bullet point and align to the paragraph. When I tried to leave it without indentation, it read as another sentence.
--
To view, visit https://review.coreboot.org/c/coreboot/+/85680?usp=email
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email
Gerrit-MessageType: comment
Gerrit-Project: coreboot
Gerrit-Branch: main
Gerrit-Change-Id: Id585b064054b338ea8cead6edb6c5153030b9cde
Gerrit-Change-Number: 85680
Gerrit-PatchSet: 2
Gerrit-Owner: Alicja Michalska <ahplka19(a)gmail.com>
Gerrit-Reviewer: Nicholas Chin <nic.c3.14(a)gmail.com>
Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>
Gerrit-Attention: Nicholas Chin <nic.c3.14(a)gmail.com>
Gerrit-Comment-Date: Sun, 05 Jan 2025 22:37:42 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Comment-In-Reply-To: Nicholas Chin <nic.c3.14(a)gmail.com>
Attention is currently required from: Alicja Michalska.
Nicholas Chin has posted comments on this change by Alicja Michalska. ( https://review.coreboot.org/c/coreboot/+/85680?usp=email )
The change is no longer submittable: All-Comments-Resolved is unsatisfied now.
Change subject: Documentation: Add Topton N100 (X2F)
......................................................................
Patch Set 2:
(1 comment)
File Documentation/mainboard/topton/adl/x2f-n100.md:
https://review.coreboot.org/c/coreboot/+/85680/comment/e382bc19_dc277dbc?us… :
PS2, Line 37: Without opening the case and connecting the SPI flasher.
Is this indent intentional? Only the extra newline is necessary to make this appear on a separate line from the bullet points. The indent makes it aligned with the bullet point text, rather than the preceding paragraph (there's no indent in a similar line on the Polestar G613 patch)
--
To view, visit https://review.coreboot.org/c/coreboot/+/85680?usp=email
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email
Gerrit-MessageType: comment
Gerrit-Project: coreboot
Gerrit-Branch: main
Gerrit-Change-Id: Id585b064054b338ea8cead6edb6c5153030b9cde
Gerrit-Change-Number: 85680
Gerrit-PatchSet: 2
Gerrit-Owner: Alicja Michalska <ahplka19(a)gmail.com>
Gerrit-Reviewer: Nicholas Chin <nic.c3.14(a)gmail.com>
Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>
Gerrit-Attention: Alicja Michalska <ahplka19(a)gmail.com>
Gerrit-Comment-Date: Sun, 05 Jan 2025 22:35:24 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Attention is currently required from: Alicja Michalska.
Nicholas Chin has posted comments on this change by Alicja Michalska. ( https://review.coreboot.org/c/coreboot/+/85680?usp=email )
Change subject: Documentation: Add Topton N100 (X2F)
......................................................................
Patch Set 2: Code-Review+2
--
To view, visit https://review.coreboot.org/c/coreboot/+/85680?usp=email
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings?usp=email
Gerrit-MessageType: comment
Gerrit-Project: coreboot
Gerrit-Branch: main
Gerrit-Change-Id: Id585b064054b338ea8cead6edb6c5153030b9cde
Gerrit-Change-Number: 85680
Gerrit-PatchSet: 2
Gerrit-Owner: Alicja Michalska <ahplka19(a)gmail.com>
Gerrit-Reviewer: Nicholas Chin <nic.c3.14(a)gmail.com>
Gerrit-Reviewer: build bot (Jenkins) <no-reply(a)coreboot.org>
Gerrit-Attention: Alicja Michalska <ahplka19(a)gmail.com>
Gerrit-Comment-Date: Sun, 05 Jan 2025 22:27:19 +0000
Gerrit-HasComments: No
Gerrit-Has-Labels: Yes