summaryrefslogtreecommitdiffstats
path: root/doc/dev_guide
Commit message (Collapse)AuthorAgeFilesLines
* doc: autogenerate a list of authors and hall of famePeter Marheine2025-02-281-0/+3
| | | | | | | | | | | | | | | This adds a build-time option to automatically generate a list of authors from git history, and includes it in the documentation by reading the output from git in a Sphinx extension. When git isn't available or the project source doesn't appear to be a git checkout, the list is not generated and gracefully replaced with a message explaining its absence. Change-Id: I1e9634a90e84262aafd80590deba9875f4b71a3c Signed-off-by: Peter Marheine <pmarheine@chromium.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/86350 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
* doc: Add missing step in the beginning of building from source docAnastasia Klimchuk2025-02-242-0/+5
| | | | | | | | Change-Id: Id834d3de69c038f3cc1aee3c59c3607f42fd5b49 Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/86429 Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* doc: Remove reference to coreboot dev guidelinesStefan Reinauer2025-02-241-6/+0
| | | | | | | | | | | | The guidelines are fully specified on flashrom.org, no need to reference them. Change-Id: If5fbcf1f4dc00dd1a9c48e9fad6c99d646954bfb Signed-off-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/86547 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Anastasia Klimchuk <aklm@chromium.org> Reviewed-by: Andy Ebrahiem <ahmet.ebrahiem@9elements.com>
* doc: Point to correct kernel coding styleStefan Reinauer2025-02-241-1/+1
| | | | | | | | | | | | Right now it points to the source of the page instead of the actual page. Change-Id: Ib52de1312419cc48478fb965ccb104bdb0dea9b6 Signed-off-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/86545 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Andy Ebrahiem <ahmet.ebrahiem@9elements.com> Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
* cli_client: Add rpmc command supportMatti Finder2024-11-111-2/+6
| | | | | | | | | | | | | | | | | | | | | | This commit adds uses the new rpmc command implementation to add them as a new feature to the cli_client. Also adds the necessary documentation for this new feature. Tested on the Winbond W25R128JV as a 'SFDP-capable chip'. This patch was done to add rpmc command support to flashrom. This enables users to write root keys to their flash chips while they flash data on the chip. This might become useful in the future as rpmc support is extended in coreboot. Also adds debug tools to flashrom, which might be useful in implementing coreboots rpmc support. Change-Id: I36c823bbee65f256eb6edabe6f058321c9a0cfa1 Signed-off-by: Matti Finder <matti.finder@gmail.com> Reviewed-on: https://review.coreboot.org/c/flashrom/+/84840 Reviewed-by: Peter Marheine <pmarheine@chromium.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
* VERSION: Change name pattern to match tag name from now onAnastasia Klimchuk2024-10-251-11/+17
| | | | | | | | | | | This patch updated the VERSION file itself, and the document on release process. Change-Id: I2bd2e57e42c29ea5a9d8bc334b86c6fa5c4b46a4 Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/84811 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org>
* doc: Add doc describing release processAnastasia Klimchuk2024-08-122-0/+101
| | | | | | | | Change-Id: Id6aacf5ef3879a5e236759e7a4a6af3cf7cc0a00 Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/83762 Reviewed-by: Peter Marheine <pmarheine@chromium.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* Remove the MakefilePeter Marheine2024-08-122-196/+0
| | | | | | | | | | | | As was described in the version 1.4 release notes, this deletes the Makefile and supporting elements leaving Meson as the only supported buildsystem. Signed-off-by: Peter Marheine <pmarheine@chromium.org> Change-Id: Ib3cf22cf636ef9b70527b734ffa34aead2a74edd Reviewed-on: https://review.coreboot.org/c/flashrom/+/83673 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
* doc: Make OS specific instructions as headers so they are linkableAnastasia Klimchuk2024-04-121-96/+120
| | | | | | | | | | | | When html page is generated, all headers are generated as links on the page. It is useful to have OS specific instructions as a link to share with people. Change-Id: I78645131b1f0acbedcf11964a204a24c45b62cff Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/81780 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi
* doc/dev_guide: Add section about Jenkins build, and scan-buildAnastasia Klimchuk2024-03-271-0/+17
| | | | | | | | | Change-Id: I416b632c55d1ceb925456ac8c8947dfbcef2e888 Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/81261 Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org>
* doc: Add doc how to support flashrom projectAnastasia Klimchuk2024-03-051-0/+2
| | | | | | | | | | Change-Id: I59a4f5978bc8ffa8ca3a3dc3f15c770ef5fcedce Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/80729 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Patrick Georgi <patrick@coreboot.org> Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org>
* doc: Add doc how to add unit testsAnastasia Klimchuk2024-02-111-0/+1
| | | | | | | | Change-Id: I73f6add194a531c4f88b822d92c31ec67c23d2dc Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/80340 Reviewed-by: Peter Marheine <pmarheine@chromium.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* docs: Add guideline about Gerrit display namesAnastasia Klimchuk2023-11-301-0/+2
| | | | | | | | | | | | | If none of "Full name" or "Display name" is set for a Gerrit account, code reviews emails are sent from "Name of user not set" instead of a user name. It is worth clarifying explicitly in the docs. Change-Id: I69b6f5c1c56a2798dd156582cb5fa246b2396ab3 Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/79250 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org> Reviewed-by: Stanislav Ponomarev <me@stasponomarev.com>
* doc: Add meson test command to TLDR for meson instructionsAnastasia Klimchuk2023-11-021-0/+1
| | | | | | | | | | | | | | | | | Running tests is one of the regular things to do in dev process, same as compile, so it should be highlighted in the TLDR section of the document. The patch adds test command to TLDR version in README file, and in dedicated meson instructions doc. Change-Id: I67d5f4decdac15e6a72f4372135dab7d44396594 Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/78689 Reviewed-by: Jes Klinke <jbk@chromium.org> Reviewed-by: Alexander Goncharov <chat@joursoir.net> Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org>
* doc: Fix formatting for the example of commit messageAnastasia Klimchuk2023-10-011-3/+1
| | | | | | | | | | | | | | | 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>
* tree: Rename master branch to mainStefan Reinauer2023-09-241-3/+3
| | | | | | | | Change-Id: I8f4a377735f3f6ab4a22006949ff294a218bdf22 Signed-off-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/75706 Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
* doc: Add link to flashrom patches to dev guideAnastasia Klimchuk2023-08-071-0/+1
| | | | | | | | | | | | | | | | | People might be interested in what's currently ongoing in development, and even more practically, have a look at examples before creating their own patch. In fact, the latter is a good idea to do. Giving the link in the intro of dev guide will encourage that. Viewing the patches does not require an account, so can be done at the very beginning. Change-Id: Iecd31a5e9a3683480b33fb9ba331545a0cf669b4 Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/76771 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org>
* doc: Fix the example Signed-off-by line to be displayed properlyAnastasia Klimchuk2023-07-271-3/+1
| | | | | | | | | | | | It was not displayed, so needed to be fixed. Secondly, it is just one line and can be an inline code markup instead of a code-block (the latter was not displayed for some reasons). Change-Id: I0f26d6fb03d1491daefa4a362068f674230e94a6 Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/76663 Reviewed-by: Peter Marheine <pmarheine@chromium.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* doc: Add new Development guidelinesAnastasia Klimchuk2023-07-202-0/+344
| | | | | | | | | Change-Id: I7fe9ab2e27fead8e795138294219b11240f15928 Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/75906 Reviewed-by: Alexander Goncharov <chat@joursoir.net> Reviewed-by: Peter Marheine <pmarheine@chromium.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* doc: Add build instructions for NI-845x on WindowsThomas Heijligen2023-07-132-9/+26
| | | | | | | | | | | | | | | Because this patch adds a new footprint level, Sphinx incorrectly interprets the 3 asterisks (***) as the start of a bold block, rather than a footnote marker. To work around this, use sphinx built-in footprints. Change-Id: I97ad08632f35aa241b3d19d9ce7711146e3f1f4a Signed-off-by: Thomas Heijligen <thomas.heijligen@secunet.com> Signed-off-by: Peter Marheine <pmarheine@chromium.org> Signed-off-by: Alexander Goncharov <chat@joursoir.net> Reviewed-on: https://review.coreboot.org/c/flashrom/+/75270 Reviewed-by: Anastasia Klimchuk <aklm@chromium.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
* doc: Add Windows MSYS2 build instructionsThomas Heijligen2023-07-131-1/+16
| | | | | | | | | | Change-Id: I847428535547242ff32af92c4fe8477241826814 Signed-off-by: Thomas Heijligen <thomas.heijligen@secunet.com> Reviewed-on: https://review.coreboot.org/c/flashrom/+/75189 Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Anastasia Klimchuk <aklm@chromium.org> Reviewed-by: Alexander Goncharov <chat@joursoir.net>
* README: Extract instructions for meson and make into separate docsAnastasia Klimchuk2023-05-233-3/+201
| | | | | | | | | | | | | | | | | This patch extracts building/installing/packaging documentation for meson and make into two separate doc files, and then links these files from README. Re-structure README so that it gives only a brief overview of build instructions and links to full instructions for meson and make. Ticket: https://ticket.coreboot.org/issues/489 Change-Id: I2d5900538d54c43efcc8c5b7010df5d867f3b190 Signed-off-by: Anastasia Klimchuk <aklm@chromium.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/75125 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org>
* doc: Convert build documentation to sphinxThomas Heijligen2023-04-272-0/+261
These build instructions are mostly based on `Documentation/building.md` and the wiki. There are some `.. todo::` sections still present in the documentation. They will be completed later. For some of the todos content needs to be written, some others require custom sphinx-plugins to be implemented. The `.. todo::` sections are only visible in the source, not in the rendered html. Change-Id: I96771e98b313a6d26dd2be940ff37998d4124324 Signed-off-by: Thomas Heijligen <thomas.heijligen@secunet.com> Reviewed-on: https://review.coreboot.org/c/flashrom/+/73359 Reviewed-by: Alexander Goncharov <chat@joursoir.net> Reviewed-by: Edward O'Callaghan <quasisec@chromium.org> Reviewed-by: Anastasia Klimchuk <aklm@chromium.org> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
generated by cgit v1.2.3 (git 2.46.0) at 2025-04-29 00:54:40 +0000