mirror of
https://review.coreboot.org/flashrom.git
synced 2025-04-26 22:52:34 +02:00

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>
54 lines
2.1 KiB
ReStructuredText
54 lines
2.1 KiB
ReStructuredText
===============================
|
|
Recent development (unreleased)
|
|
===============================
|
|
|
|
This document describes the major changes that are expected to be included in
|
|
the next release of flashrom and which are currently only available by source
|
|
code checkout (see :doc:`../dev_guide/building_from_source`). These changes
|
|
may be further revised before the next release.
|
|
|
|
Known issues
|
|
============
|
|
|
|
AMD-based PCs with FCH are unable to read flash contents for internal (BIOS
|
|
flash) chips larger than 16 MB, and attempting to do so may crash the system.
|
|
Systems with AMD "Promontory" IO extenders (mostly "Zen" desktop platforms) are
|
|
not currently supported.
|
|
|
|
https://ticket.coreboot.org/issues/370
|
|
|
|
flashchips.c split into separate files by vendor
|
|
================================================
|
|
|
|
``flashchips.c`` file was split into separate files per vendor. flashchips.c still exists in the source
|
|
code but it is much smaller and only contain "generic" chip entries.
|
|
|
|
With this, instead of one file ``flashchips.c`` we now have a ``flashchips/`` directory which contains
|
|
all the files.
|
|
|
|
There are no changes to the usage, and everything that's supported stays the same.
|
|
|
|
New features
|
|
============
|
|
|
|
-r/-w/-v argument is optional when using -i
|
|
-------------------------------------------
|
|
|
|
See :doc:`/classic_cli_manpage` for details.
|
|
|
|
Hall of Fame added to documentation
|
|
-----------------------------------
|
|
|
|
The flashrom HTML documentation (and web site) now includes an
|
|
automatically-generated list of historical contributors, to acknowledge
|
|
everybody who has made flashrom into what it is:
|
|
:doc:`../about_flashrom/hall_of_fame`.
|
|
|
|
When building the documentation, the ``generate_authors_list`` Meson option will
|
|
cause the lists to be generated, requiring a runnable copy of Git on the system
|
|
and that the source tree being built is a Git working copy. If those
|
|
requirements are not satisfied or the option is disabled, the authors lists will
|
|
be replaced with placeholders unless the ``generate_authors_list`` option is set
|
|
to ``enabled`` in which case the build will fail if the requirements are not
|
|
satisfied.
|