openwrt/flashrom
1
0
Fork 0
mirror of https://review.coreboot.org/flashrom.git synced 2025-07-03 15:03:22 +02:00
Code Issues Releases Wiki Activity

doc: autogenerate a list of authors and hall of fame

Browse Source 
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>
This commit is contained in:
Peter Marheine
2025-02-11 16:37:23 +11:00
committed by Anastasia Klimchuk
parent 07beef6999
commit 0b39a3e00c
12 changed files with 278 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
doc/about_flashrom/hall_of_fame.rst Normal file
View File

@ -0,0 +1,57 @@
============
Hall of Fame
============
This is the flashrom project's hall of fame, where we credit everybody who
has contributed to flashrom's code in the past.
Based on the Git history (dating back to 2002!), this page separately lists all
:ref:`authors <authors>` and :ref:`reviewers <reviewers>` where each line
lists a person's name and how many commits they are credited for. [#svn]_
flashrom is alive and running because of you all, the people who during all
these years (and decades!) give their time, energy, knowledge, and a piece of
their heart to flashrom. The project is what we all are creating together.
**Thank you everyone so much!**
.. _authors:
Authors
=======
The people listed here are those credited as the author or a co-author (as
in ``Co-authored-by`` or ``Co-developed-by``) of at least one Git commit in
flashrom.
.. flashrom-authors:: authors
This copy of the flashrom documentation was built without
generating the list of authors. To generate it, ensure
the :code:`generate_authors_list`
:ref:`Meson option <meson_configuration>` is enabled when
building.
.. _reviewers:
Reviewers
=========
The people listed here are those credited as a reviewer (``Reviewed-by``)
of at least one Git commit in flashrom.
We very much appreciate flashrom code reviews; you can read more about it
in our :ref:`code review documentation <support-code-reviews>`.
.. flashrom-authors:: reviewers
This copy of the flashrom documentation was built without
generating the list of reviewers. To generate it, ensure
the :code:`generate_authors_list`
:ref:`Meson option <meson_configuration>` is enabled when
building.
.. [#svn] Data for contributions prior to 2017 may be inaccurate or missing,
because flashrom used SVN rather than Git prior to then and old metadata might
not be in a format that is understood by the scripts that automatically generate
this page.