mirror of
https://review.coreboot.org/flashrom.git
synced 2025-07-19 22:40:54 +02:00
af51624516
Building authors/reviewers list (aka Hall of Fame) requires
more modern sphinx version than the rest of documentation. Also
we have separate meson options, `documentation` and
`generate_authors_list`, which both default to `auto`.
Auto mode is expected to check the environment and enable the
option if environment is suitable - or disable otherwise.
The patch check minimun required sphinx version specifically
for building hall of fame, the rest of documentation just checks
that sphinx is present.
So if developer has old version of sphinx, all the documentation
will be built, just without hall of fame.
Without this patch, developer with generate_authors_list=auto
(which is default) and old version of sphinx gets a build error
like this:
Exception occurred:
File "/usr/lib/python3/dist-packages/docutils/nodes.py",
line 652, in __getitem__
return self.attributes[key]
KeyError: 'colwidth'
and a stack trace from sphinx source code
Change-Id: I8f0ae62f33dca04c2c5233ea45c6263f10cbe4f9
Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/88373
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Peter Marheine <pmarheine@chromium.org>
flashrom README
===============
flashrom is a utility for detecting, reading, writing, verifying and erasing
flash chips. It is often used to flash BIOS/EFI/coreboot/firmware images
in-system using a supported mainboard, but it also supports flashing of network
cards (NICs), SATA controller cards, and other external devices which can
program flash chips.
It supports a wide range of flash chips (most commonly found in SOIC8, DIP8,
SOIC16, WSON8, PLCC32, DIP32, TSOP32, and TSOP40 packages), which use various
protocols such as LPC, FWH, parallel flash, or SPI.
Do not use flashrom on laptops (yet)! The embedded controller (EC) present in
many laptops might interact badly with any attempts to communicate with the
flash chip and may brick your laptop.
Please make a backup of your flash chip before writing to it.
Please see the flashrom(8) manpage :doc:`classic_cli_manpage`.
The list of platforms that package flashrom can be found on `repology.org <https://repology.org/project/flashrom/versions>`_.
Information about recent releases can be found in :doc:`/release_notes/index`.
Building / installing / packaging
---------------------------------
flashrom is built with **meson**. TLDR:
::
meson setup builddir
meson compile -C builddir
meson test -C builddir
meson install -C builddir
For full detailed instructions, follow the information in
:doc:`dev_guide/building_from_source`.
If you are interested in development, have a look at :doc:`dev_guide/development_guide`.
Contact
-------
The official flashrom website is:
https://www.flashrom.org/
For available contact methods see :doc:`contact`