1
0
mirror of https://review.coreboot.org/flashrom.git synced 2025-04-27 23:22:37 +02:00

doc: Make OS specific instructions as headers so they are linkable

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
This commit is contained in:
Anastasia Klimchuk 2024-04-08 23:43:01 +10:00 committed by Anastasia Klimchuk
parent 7bc347e16d
commit c06abc9014

View File

@ -47,8 +47,11 @@ Installing dependencies
* No external dependencies (documentation should be build without fetching all of pypi) * No external dependencies (documentation should be build without fetching all of pypi)
* No Javascript? * No Javascript?
* Linux Linux
"""""
* Debian / Ubuntu * Debian / Ubuntu
:: ::
apt-get install -y \ apt-get install -y \
@ -56,6 +59,7 @@ Installing dependencies
libcmocka-dev libpci-dev libusb-1.0-0-dev libftdi1-dev libjaylink-dev libcmocka-dev libpci-dev libusb-1.0-0-dev libftdi1-dev libjaylink-dev
* ArchLinux / Manjaro * ArchLinux / Manjaro
:: ::
pacman -S --noconfirm \ pacman -S --noconfirm \
@ -63,6 +67,7 @@ Installing dependencies
pciutils libusb libftdi libjaylink pciutils libusb libftdi libjaylink
* openSUSE / SUSE * openSUSE / SUSE
:: ::
zypper install -y \ zypper install -y \
@ -70,6 +75,7 @@ Installing dependencies
libcmocka-devel pciutils-devel libusb-1_0-devel libftdi1-devel libjaylink-devel libcmocka-devel pciutils-devel libusb-1_0-devel libftdi1-devel libjaylink-devel
* NixOS / nixpkgs * NixOS / nixpkgs
* There is a ``shell.nix`` under ``scripts/`` * There is a ``shell.nix`` under ``scripts/``
:: ::
@ -79,14 +85,18 @@ Installing dependencies
cmocka pciutils libusb1 libftdi1 libjaylink cmocka pciutils libusb1 libftdi1 libjaylink
* Alpine Linux * Alpine Linux
:: ::
apk add \ apk add \
build-base meson ninja pkgconf py3-sphinx \ build-base meson ninja pkgconf py3-sphinx \
cmocka-dev pciutils-dev libusb-dev libjaylink-dev cmocka-dev pciutils-dev libusb-dev libjaylink-dev
* Windows Windows
"""""""
* MSYS2 * MSYS2
Install `MSYS2 <https://www.msys2.org/>`_ and ensure it is `fully updated <https://www.msys2.org/docs/updating/>`_. Install `MSYS2 <https://www.msys2.org/>`_ and ensure it is `fully updated <https://www.msys2.org/docs/updating/>`_.
* ``libpci`` is not available through the package manager and pci based programmer are not supported on Windows. * ``libpci`` is not available through the package manager and pci based programmer are not supported on Windows.
@ -106,8 +116,11 @@ Installing dependencies
mingw-w64-i686-gcc mingw-w64-i686-meson mingw-w64-i686-ninja mingw-w64-i686-pkg-config mingw-w64-i686-python-sphinx \ mingw-w64-i686-gcc mingw-w64-i686-meson mingw-w64-i686-ninja mingw-w64-i686-pkg-config mingw-w64-i686-python-sphinx \
mingw-w64-i686-cmocka mingw-w64-i686-libusb mingw-w64-i686-libftdi mingw-w64-i686-libjaylink-git mingw-w64-i686-cmocka mingw-w64-i686-libusb mingw-w64-i686-libftdi mingw-w64-i686-libjaylink-git
* MacOS MacOS
"""""
* Homebrew * Homebrew
* ``libpci`` is not available through the package manager * ``libpci`` is not available through the package manager
* ``libjaylink`` is not available through the package manager * ``libjaylink`` is not available through the package manager
@ -117,8 +130,11 @@ Installing dependencies
meson ninja pkg-config sphinx-doc \ meson ninja pkg-config sphinx-doc \
libusb libftdi libusb libftdi
* BSD BSD
"""
* FreeBSD / DragonFlyBSD * FreeBSD / DragonFlyBSD
* ``libusb1`` is part of the system * ``libusb1`` is part of the system
* ``libjaylink`` is not available through the package manager * ``libjaylink`` is not available through the package manager
@ -129,6 +145,7 @@ Installing dependencies
cmocka libpci libftdi1 cmocka libpci libftdi1
* OpenBSD * OpenBSD
* ``libjaylink`` is not available through the package manager * ``libjaylink`` is not available through the package manager
:: ::
@ -138,6 +155,7 @@ Installing dependencies
cmocka pciutils libusb1 libftdi1 cmocka pciutils libusb1 libftdi1
* NetBSD * NetBSD
* ``libjaylink`` is not available through the package manager * ``libjaylink`` is not available through the package manager
* note: https://www.cambus.net/installing-ca-certificates-on-netbsd/ * note: https://www.cambus.net/installing-ca-certificates-on-netbsd/
@ -147,7 +165,9 @@ Installing dependencies
meson ninja pkg-config py39-sphinx \ meson ninja pkg-config py39-sphinx \
cmocka pciutils libusb1 libftdi1 cmocka pciutils libusb1 libftdi1
* OpenIndiana (Illumos, Solaris, SunOS) OpenIndiana (Illumos, Solaris, SunOS)
"""""""""""""""""""""""""""""""""""""
* ``libpci`` missing, pciutils is build without it * ``libpci`` missing, pciutils is build without it
* ``libftdi1`` & ``libjaylink`` are not available through the package manager * ``libftdi1`` & ``libjaylink`` are not available through the package manager
* TODO: replace ``build-essential`` with the default compiler * TODO: replace ``build-essential`` with the default compiler
@ -156,7 +176,9 @@ Installing dependencies
pkg install build-essential meson ninja cmocka libusb-1 pkg install build-essential meson ninja cmocka libusb-1
* DJGPP-DOS DJGPP-DOS
"""""""""
* Get `DJGPP <https://www.delorie.com/djgpp/>`_ * Get `DJGPP <https://www.delorie.com/djgpp/>`_
* A great build script can be found `here <https://github.com/andrewwutw/build-djgpp>`_ * A great build script can be found `here <https://github.com/andrewwutw/build-djgpp>`_
* Download the `pciutils <https://mj.ucw.cz/sw/pciutils/>`_ sources * Download the `pciutils <https://mj.ucw.cz/sw/pciutils/>`_ sources
@ -181,7 +203,9 @@ Installing dependencies
* To compile flashrom use the ``meson_cross/i586_djgpp_dos.txt`` cross-file * To compile flashrom use the ``meson_cross/i586_djgpp_dos.txt`` cross-file
* You will need `CWSDPMI.EXE <https://sandmann.dotster.com/cwsdpmi/>`_ to run flashrom * You will need `CWSDPMI.EXE <https://sandmann.dotster.com/cwsdpmi/>`_ to run flashrom
* libpayload libpayload
""""""""""
.. todo:: Add building instructions for libpayload .. todo:: Add building instructions for libpayload