summaryrefslogtreecommitdiffstats
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: Release notes for the 24.02 release24.02Martin Roth2024-02-201-29/+212
| | | | | | | | | | | | | These will be updated and finalized after the release to capture any final changes, remove "upcoming release", and finalize all stats. Change-Id: Idc224c43f2459faabf91a9ef282bb9eaeba42240 Signed-off-by: Martin Roth <gaumless@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/80617 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Reviewed-by: Matt DeVillier <matt.devillier@gmail.com> Reviewed-by: ron minnich <rminnich@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* util/showdevicetree: drop unmaintained toolFelix Held2024-02-141-1/+0
| | | | | | | | | | | | | This tool doesn't have a makefile, when trying to compile it manually with the given instructions it even fails to compile after fixing the paths in the given command, and it references the non-existing PCI_BUS_SEGN_BITS Kconfig symbol, so just drop this. Signed-off-by: Felix Held <felix-coreboot@felixheld.de> Change-Id: I8ca75db281a215bf3f194ab72a107f666dc0694e Reviewed-on: https://review.coreboot.org/c/coreboot/+/79934 Reviewed-by: Martin Roth <martin.roth@amd.corp-partner.google.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* Documentation/vboot: Update vboot supported boards listMatt DeVillier2024-02-141-10/+12
| | | | | | | | | | Auto-generated by util/vboot_list/vboot_list.sh. Change-Id: I35dc51915c8468543c981e1b046e4ecf8d5b4bbf Signed-off-by: Matt DeVillier <matt.devillier@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/80458 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Martin L Roth <gaumless@gmail.com>
* Documentation: Update Makefile .inc references to .mkMartin Roth2024-01-265-13/+13
| | | | | | | | | Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: I464170e60a22f39225044c6794d091455d931e9c Reviewed-on: https://review.coreboot.org/c/coreboot/+/80128 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Held <felix-coreboot@felixheld.de>
* Documentation: Fix trivial typo in the "Coding Style" chapterTillmann Severin2024-01-211-1/+1
| | | | | | | | | | | This should not have any impact on produced binaries. Due to the simplicity, the patch has not been tested. Change-Id: Ic52f2be6a91aa3534d222f08733d1ba8bc1265a9 Signed-off-by: Tillmann Severin <tillmann.severin@mailbox.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/80140 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* mb/google/brya: Drop primus4es boardJakub Czapiga2024-01-181-1/+0
| | | | | | | | | | | | | Primus4es board is no longer supported thus drop it from the tree. TEST=Build all Brya boards in CrOS-SDK - Primus4ES not built. No negative impact observed. Change-Id: I0502b2eed6f80d648b422c8d1622d504a6c93822 Signed-off-by: Jakub Czapiga <czapiga@google.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/79916 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Subrata Banik <subratabanik@google.com> Reviewed-by: Eric Lai <ericllai@google.com>
* Documentation: Start administrator handbookPatrick Georgi2024-01-122-1/+53
| | | | | | | | | | | Let's spread the work of maintaining various of our services, but to achieve that, we need to document what needs to be done. Change-Id: I87021ee62d18fa464f70351ea8bad732889d55f1 Signed-off-by: Patrick Georgi <patrick@coreboot.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/79901 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* Documentation/getting_started: Add a FAQ documentMartin Roth2024-01-062-0/+313
| | | | | | | | | | Signed-off-by: Martin Roth <gaumless@gmail.com> Signed-off-by: Matt DeVillier <matt.devillier@gmail.com> Change-Id: Ia324e4800bf9dfc7ad86f4f99272c87ac566304e Reviewed-on: https://review.coreboot.org/c/coreboot/+/79441 Reviewed-by: Arthur Heymans <arthur@aheymans.xyz> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* Documentation: Update internal URL'sJon Murphy2024-01-041-1/+1
| | | | | | | | | | | Update URL's to point to head rather than the deprecated refs/heads/master. Change-Id: I16f0c087762ff049115b67de3ac0b881aa4e4b40 Signed-off-by: Jon Murphy <jpmurphy@google.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/79785 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Matt DeVillier <matt.devillier@amd.corp-partner.google.com>
* Documentation: Add Protectli to ships-with-coreboot hw listFilip Lewiński2023-12-281-0/+10
| | | | | | | | Change-Id: Iff642f5122e7132d96177f2ed1680ece42aac095 Signed-off-by: Filip Lewiński <filip.lewinski@3mdeb.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/79215 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Michał Żygowski <michal.zygowski@3mdeb.com>
* doc/releases/4.22: Replace unicode chars with ASCIIFelix Singer2023-11-261-3/+3
| | | | | | | | Change-Id: I0b8419a8ad01d711362733e02ace89c48d2893b2 Signed-off-by: Felix Singer <felixsinger@posteo.net> Reviewed-on: https://review.coreboot.org/c/coreboot/+/79232 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Nicholas Chin <nic.c3.14@gmail.com>
* util/kconfig: Uprev to Linux 6.6's kconfigPatrick Georgi2023-11-251-7/+3
| | | | | | | | | | | | | | | | | | Upstream reimplemented KCONFIG_STRICT, just calling it KCONFIG_WERROR. Therefore, adapt our build system and documentation. Upstream is less strict at this time, but there's a proposed patch that got imported. TEST=`util/abuild/abuild -C` output (config.h and config.build) remains the same. Also, the failure type fixed in https://review.coreboot.org/c/coreboot/+/11272 can be detected, which I tested by manually breaking our Kconfig in a similar way. Change-Id: I322fb08a2f7308b93cff71a5dd4136f1a998773b Signed-off-by: Patrick Georgi <patrick@coreboot.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/79259 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Martin L Roth <gaumless@gmail.com> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
* tree wide: Rename VBOOT_MEASURED_BOOT* to TPM_MEASURED_BOOTPatrick Georgi2023-11-252-2/+2
| | | | | | | | | | | | | This follows commit c79e96b4eb3 which did the rename across the tree except in these places. Remove the flag from CHROMEOS abuild builds because it never really belonged there. Change-Id: If98fa27f64d6b676d3edf68ba6fbaacf7ac422e4 Signed-off-by: Patrick Georgi <patrick@coreboot.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/79258 Reviewed-by: Arthur Heymans <arthur@aheymans.xyz> Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
* Docs/releases: Finalize 4.22/4.22.01 release notesMartin Roth2023-11-251-11/+22
| | | | | | | | | | | | | | | | Now that the 4.22 release tag has been added to git, update the release notes with the final statistics and wording. We also decided to add a fix submitted immediately after the 4.22 release was tagged into the release package and do a point release. This also adds an expected date for the next release Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Iae9653a275fcc1d11efbb88e12676f332be0a5dc Reviewed-on: https://review.coreboot.org/c/coreboot/+/79147 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* Documentation/releases: Add 24.02 release notes templateMartin Roth2023-11-192-1/+101
| | | | | | | | | | | In preparation for the upcoming release, add the template for the 24.02 release and update index.md. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: I694142c31ba684e7b94640d55302b2440e25619a Reviewed-on: https://review.coreboot.org/c/coreboot/+/79073 Reviewed-by: Matt DeVillier <matt.devillier@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* Docs/releases: Update 4.22 release notesMartin Roth2023-11-181-60/+270
| | | | | | | | | | | | These should be the final release notes prior to tagging coreboot Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Id723f8e1fc92ef1a36e877f48e594eef59b0ba8e Reviewed-on: https://review.coreboot.org/c/coreboot/+/79077 Reviewed-by: Jason Glenesk <jason.glenesk@gmail.com> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Matt DeVillier <matt.devillier@gmail.com>
* Docs/security/vboot: Update list of boards with vbootMartin Roth2023-11-171-12/+24
| | | | | | | | | | Update the vboot board list for the 4.22 release. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: I77c5ca2c2c36d8b1ddadad4f15d2d4148ff0b325 Reviewed-on: https://review.coreboot.org/c/coreboot/+/79071 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Jason Glenesk <jason.glenesk@gmail.com>
* doc/soc/intel/xeon_sp: Add Xeon-SP coreboot community preview guideShuo Liu2023-11-073-0/+129
| | | | | | | | | | | | The community preview branch for coreboot on latest Xeon Scalable processor is opensource at: https://review.coreboot.org/plugins/gitiles/intel-dev-pub/. Change-Id: Ie2ffc1722a4a26d6039b6642efa95bf072d896ad Signed-off-by: Shuo Liu <shuo.liu@intel.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/78787 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: David Hendricks <david.hendricks@gmail.com>
* Documentation: order distributions alphabeticallyMarkus Meissner2023-11-021-36/+35
| | | | | | | | Change-Id: I95d4347791988087d90992b45120ff34ba2da1c5 Signed-off-by: Markus Meissner <coder@safemailbox.de> Reviewed-on: https://review.coreboot.org/c/coreboot/+/78864 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* Documentation: add Nitrokey to distributionsMarkus Meissner2023-11-011-0/+10
| | | | | | | | | | Nitrokey offers various products, which have coreboot pre-installed. Change-Id: I3ef25e0e1cb97eda5fd457bdb650f3ee3f00210a Signed-off-by: Markus Meissner <coder@safemailbox.de> Reviewed-on: https://review.coreboot.org/c/coreboot/+/78299 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* Documentation: Update 4.22 release notes with x86 CBFS cache supportJeremy Compostella2023-10-301-0/+38
| | | | | | | | Change-Id: I7c9ecdc3f8316fdec0bc1bc188f1959fb8b5a458 Signed-off-by: Jeremy Compostella <jeremy.compostella@intel.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/78655 Reviewed-by: Nicholas Chin <nic.c3.14@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* doc/lib/flashmap: Fix incorrect path to FMD implementationNicholas Sudsgaard2023-10-281-1/+1
| | | | | | | | Change-Id: I6864cd041d7173cd284f47d09f4388341a7ee756 Signed-off-by: Nicholas Sudsgaard <devel+coreboot@nsudsgaard.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/78690 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* Documentation: Update 4.22 release notes with x86 .data sectionJeremy Compostella2023-09-271-0/+40
| | | | | | | | | Change-Id: I2d6d611df8930ad0c473489eacee9019cbdacb9e Signed-off-by: Jeremy Compostella <jeremy.compostella@intel.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/78000 Reviewed-by: Bora Guvendik <bora.guvendik@intel.com> Reviewed-by: Martin L Roth <gaumless@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* Documentation/external_docs.md: Add link to EGS paperDavid Hendricks2023-09-261-0/+1
| | | | | | | | | | | Intel published a technical paper about coreboot on Eagle Stream. The document number is 778593. Signed-off-by: David Hendricks <ddaveh@amazon.com> Change-Id: Ic67f9a69b7e2ea526c3c5a604e38bb939c72feec Reviewed-on: https://review.coreboot.org/c/coreboot/+/78117 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
* Doc/: Remove an extra spacePatrick Georgi2023-09-241-1/+1
| | | | | | | | Change-Id: I462d0bd3e9f3b425631987fa793d29323c3f9d61 Signed-off-by: Patrick Georgi <patrick@coreboot.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/78021 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Martin L Roth <gaumless@gmail.com>
* Doc/infra: Update my contact informationPatrick Georgi2023-09-241-2/+1
| | | | | | | | Change-Id: If7081897d8232e3ac84de0fa76689ad05808996d Signed-off-by: Patrick Georgi <patrick@coreboot.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/78020 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Martin L Roth <gaumless@gmail.com>
* Documentation: Remove unused build targetsFelix Singer2023-09-212-138/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | The options in conf.py for the following build targets are either commented out or contain example values, which suggests that there was no interest in them recently. Their comments also seem more like generated examples. * LaTeX * man pages * Texinfo In order to clean up our configs and scripts for the documentation, remove the configuration options from conf.py for these build targets. Also, remove the build targets responsible for generating a PDF file from Makefile. Don't touch Makefile.sphinx for now though as we usually wrap around it. We may bring these build targets back if there is real interest in them, but it seems only the HTML target was really used. Change-Id: I7df8ea886f94d9b25e8eeb0ccbc2a7392b96a575 Signed-off-by: Felix Singer <felixsinger@posteo.net> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77439 Reviewed-by: Martin L Roth <gaumless@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* mb/x11-lga1151-series: Add x11ssw-fKieran Kunhya2023-09-212-0/+77
| | | | | | | | | | | | This board is similar to x11ssm-f but has a proprietary form factor with NVMe and a single x16 slot (potentially bifurcated to 2x x8) and a x4 slot. Change-Id: I53a0b6012ae64cf1ba4b625f11aaf771637307f3 Signed-off-by: Kieran Kunhya <kieran@kunhya.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77610 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Michael Niewöhner <foss@mniewoehner.de>
* Documentation: Adjust master -> main branchStefan Reinauer2023-09-157-23/+23
| | | | | | | | | | Some of our documentation still points to the wrong branches Change-Id: Idb72e4f44f294f64eb01c588027d300a53d6fb41 Signed-off-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77875 Reviewed-by: Patrick Georgi <patrick@coreboot.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* Documentation/rmodules.md: Add rmodule DocumentationMaximilian Brune2023-09-051-0/+81
| | | | | | | | Signed-off-by: Maximilian Brune <maximilian.brune@9elements.com> Change-Id: I97cd3030cd660a86295257caf723c9f517bed146 Reviewed-on: https://review.coreboot.org/c/coreboot/+/76383 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Martin L Roth <gaumless@gmail.com>
* docs: Build in parallelSimon Glass2023-09-031-1/+4
| | | | | | | | | | | | | | Use all available cores to speed up building the documentation. As $(SPHINXOPTS) has no default in `Makefile.sphinx`, we can communicate it to all sub-makes via `export`. Change-Id: I25996f17348505722f3489a15a975de620331b5a Signed-off-by: Simon Glass <sjg@chromium.org> Signed-off-by: Nico Huber <nico.h@gmx.de> Original-reviewed-on: https://review.coreboot.org/c/coreboot/+/77363 Reviewed-on: https://review.coreboot.org/c/coreboot/+/77452 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Martin L Roth <gaumless@gmail.com>
* Documentation: Update coding_style.md with refactoring sectionMartin Roth2023-09-011-75/+46
| | | | | | | | | | | | | | | | | | | | | | The rule being added to the refactoring section is already present in the "coding style" section of the guide, but is currently easy to miss. Adding it to its own section makes it a little more plain and makes it more strongly worded. Update a couple of other areas: - Make kernel specific phrasing better aligned with coreboot. - Remove duplicate "try to match" phrase in coding style section. - Remove section on Data structures - it doesn't apply to coreboot. - Update text to make it clearer and more coreboot-centric. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Ic3508529f639ea0609d2ea2032cc52407e9543e5 Reviewed-on: https://review.coreboot.org/c/coreboot/+/71067 Reviewed-by: Varshit Pandya <pandyavarshit@gmail.com> Reviewed-by: Elyes Haouas <ehaouas@noos.fr> Reviewed-by: Matt DeVillier <matt.devillier@amd.corp-partner.google.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Eric Lai <eric_lai@quanta.corp-partner.google.com>
* crossgcc: Upgrade MPFR from 4.2.0 to 4.2.1Elyes Haouas2023-08-311-0/+1
| | | | | | | | Change-Id: I1fb3630bf5e8a56ddcf6102faffde568134accc9 Signed-off-by: Elyes Haouas <ehaouas@noos.fr> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77375 Reviewed-by: Martin L Roth <gaumless@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* util/crossgcc: Update binutils from 2.40 to 2.41Elyes Haouas2023-08-311-0/+1
| | | | | | | | Change-Id: I6c985974e2eeea1329b2dbb232711c72b0bd99bc Signed-off-by: Elyes Haouas <ehaouas@noos.fr> Reviewed-on: https://review.coreboot.org/c/coreboot/+/76852 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Martin L Roth <gaumless@gmail.com>
* util/crossgcc: Update GMP from 6.2.1 to 6.3.0Elyes Haouas2023-08-311-1/+1
| | | | | | | | Change-Id: I67d443cb15d89482b20b01f4068502b16ac8fc8e Signed-off-by: Elyes Haouas <ehaouas@noos.fr> Reviewed-on: https://review.coreboot.org/c/coreboot/+/76865 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Martin L Roth <gaumless@gmail.com>
* Docs/acronyms.md: Fix build warnings & update some linksMartin Roth2023-08-271-24/+24
| | | | | | | | | | | | - Change all links to wikipedia to https. - Update some links to wikipedia that were incomplete. - Update a few links that are now broken. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: If780e15997c499d1df975b436fd9af530f324eba Reviewed-on: https://review.coreboot.org/c/coreboot/+/77488 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* doc/mainboard/index: Deduplicate menu points for T530 and W530Felix Singer2023-08-271-2/+1
| | | | | | | | | | | | | | | Both mainboards have the same documentation. Instead of having two list items referring to the same document, just merge the two items. This fixes the following Sphinx warning: WARNING: duplicated entry found in toctree: mainboard/lenovo/w530 Change-Id: I4140b34db01b1d5f47a39b9c1e33405e7789de63 Signed-off-by: Felix Singer <felixsinger@posteo.net> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77503 Reviewed-by: Nicholas Chin <nic.c3.14@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* doc/mb/asus/{p2b-ls,p3b-f}: Remove reference to non-existing documentFelix Singer2023-08-272-2/+2
| | | | | | | | | | | | | | | | The document for northbridge/intel/i440bx doesn't exist and it didn't exist at the time of introduction of these two mainboard documents. So replace the reference with just the northbridge name. This fixes the following Sphinx warning: WARNING: unknown document: '../../northbridge/intel/i440bx/index' Change-Id: Iaa67399f9d0e62d5d54ae08f5ebb8c70073c601f Signed-off-by: Felix Singer <felixsinger@posteo.net> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77442 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Nicholas Chin <nic.c3.14@gmail.com>
* doc,util: Regenerate documentation filesFelix Singer2023-08-271-4/+8
| | | | | | | | | | | | | | Add new documentation generated by util/util_readme/util_readme.sh. This also fixes the following Sphinx warning: util/abuild/index.md: WARNING: document isn't included in any toctree Change-Id: I26c33af3c5a5853f6bcce23e982a6b192b01f1d7 Signed-off-by: Felix Singer <felixsinger@posteo.net> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77441 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Nicholas Chin <nic.c3.14@gmail.com>
* doc/releases/4.22: Remove transitions from sectionsFelix Singer2023-08-271-6/+0
| | | | | | | | | | | | | | Sections may not start with transitions. Remove them. This fixes the following Sphinx error: ERROR: Document or section may not begin with a transition. Change-Id: I519af83df14e44b0709dee7e338dba1ee6413f0a Signed-off-by: Felix Singer <felixsinger@posteo.net> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77440 Reviewed-by: Nicholas Chin <nic.c3.14@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* docs: Tidy up the English in the testing tutorialSimon Glass2023-08-261-15/+15
| | | | | | | | | | | | | | | | | | Tweak a few sentences noticed when reading this. BUG=none BRANCH=none TEST=none Change-Id: I0a072c83402bc551a6bbdb7cd7c55fc3505784b2 Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77096 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77464 Reviewed-by: Martin L Roth <gaumless@gmail.com> Reviewed-by: Patrick Georgi <patrick@coreboot.org> Tested-by: Patrick Georgi <patrick@coreboot.org>
* docs: Mention add_intermediate and provide an exampleSimon Glass2023-08-261-0/+17
| | | | | | | | | | | | | This is a useful feature, so add a note about it. Change-Id: If29f6480f878bdaf877dc208cc4861b884e10840 Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77342 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <patrick@coreboot.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77465 Tested-by: Patrick Georgi <patrick@coreboot.org> Reviewed-by: Martin L Roth <gaumless@gmail.com>
* docs/mb: update hp/compaq_elite_8300_usdt docsRiku Viitanen2023-08-242-6/+6
| | | | | | | | | | | | | - Internal flashing possible - Fix link - Link here from the list of mainboards - More consistent naming Change-Id: Iaf6448c1e9f0dae9480fa9785a12f09d42f8cf7d Signed-off-by: Riku Viitanen <riku.viitanen@protonmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77377 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* docs: Update with acronyms found in 4.20-4.21 commit messagesMartin Roth2023-08-241-7/+50
| | | | | | | | | Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: I19a69ffdf2c248223569153c00fbc76d5ceb7921 Reviewed-on: https://review.coreboot.org/c/coreboot/+/77382 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Arthur Heymans <arthur@aheymans.xyz> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
* Documentation/acpi: add Windows-specific documentationFelix Held2023-08-222-0/+12
| | | | | | | | | | | | | | | | When using the Windows fast startup mechanism which is enabled by default, Windows will use a cached version of the ACPI tables during normal boots after a clean shutdown. Since I've run into this issue and spent quite a bit of time debugging the wrong issue due to this, better document this possibly unexpected behavior. Signed-off-by: Felix Held <felix-coreboot@felixheld.de> Change-Id: Ia9e65f6a3aff13fa54abe68c8f5fcbf9bc6efc1a Reviewed-on: https://review.coreboot.org/c/coreboot/+/77354 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Nico Huber <nico.h@gmx.de> Reviewed-by: Paul Menzel <paulepanter@mailbox.org> Reviewed-by: Matt DeVillier <matt.devillier@gmail.com>
* Documentation: Update 4.21 release notes for upcoming release4.21Martin Roth2023-08-221-25/+373
| | | | | | | | Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Ice46117ccd3a082e20ce0d18421fd7da92aa3dbf Reviewed-on: https://review.coreboot.org/c/coreboot/+/77330 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* docs/security/vboot: Update list of platforms supporting vbootMartin Roth2023-08-221-27/+45
| | | | | | | | Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: Ie3c131db52993d99994e0d9cc04b80f480a72ab8 Reviewed-on: https://review.coreboot.org/c/coreboot/+/77335 Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* docs/releases: Add 4.22 release notes templateJason Glenesk2023-08-212-1/+56
| | | | | | | | | | Add 4.22 template and update index. Change-Id: Id44616ca70ba693fc622164469bb748ee269565b Signed-off-by: Jason Glenesk <jason.glenesk@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77277 Reviewed-by: Martin L Roth <gaumless@gmail.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* doc/soc/amd/psp: Fix indentation in rst tableNico Huber2023-08-211-3/+3
| | | | | | | | | | | | | | The indentation resulted in the following error: …/Documentation/soc/amd/psp_integration.md:22: ERROR: Unexpected indentation. Alas, the line number refers to the embedded rst. Change-Id: I9526d023af5207602c4a4cea7704b547ef1b7bf0 Signed-off-by: Nico Huber <nico.huber@secunet.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/77364 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
* Documentation: Fix conf.py for newer Sphinx versionsNicholas Chin2023-08-201-6/+4
| | | | | | | | | | | | | | | | | | | | Newer versions of Sphinx complain about the language being set to None, so explicitly set it to 'en'. The syntax that is currently used to enable custom CSS styling for tables [1] also no longer works, resulting in the docs rendering without CSS. Fix this using the html_css_files option instead. TEST: The documentation builds and renders correctly with both Sphinx 1.8.3 in from the doc.coreboot.org Docker container and Sphinx 7.2.2 from distro packages. [1] Commit a78e66e5f4: Documentation: Add static CSS file to fix tables Change-Id: I036b1cad3cfa533c0c3a037bac649caa2d968d4b Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/75466 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>