Attention is currently required from: Thomas Heijligen, Stefan Reinauer, Edward O'Callaghan, Anastasia Klimchuk.
Alexander Goncharov has posted comments on this change. ( https://review.coreboot.org/c/flashrom/+/74216 )
Change subject: doc: Convert README to sphinx ......................................................................
Patch Set 5:
(19 comments)
Patchset:
PS5: The "Build Instructions" section looks like a wall of text. It's difficult to read and navigate. Plain README used indentation for formatting, but in our case, let's use _real_ formatting - my comments suggest using **bold** format because I found it most appropriate
File README.rst:
https://review.coreboot.org/c/flashrom/+/74216/comment/85c08d22_600fedee PS5, Line 26: flashrom supports building with make and meson. ``` flashrom supports building with **make** and **meson**. ```
https://review.coreboot.org/c/flashrom/+/74216/comment/4d487ef7_fc5d9408 PS5, Line 38: To build flashrom you need to install the following software: ``` **To build flashrom you need to install the following software:** ```
https://review.coreboot.org/c/flashrom/+/74216/comment/4ccfd0e0_43513562 PS5, Line 48: Linux et al: ``` **Linux et al:** ```
https://review.coreboot.org/c/flashrom/+/74216/comment/1fa460ba_6d34d4ff PS5, Line 54: On FreeBSD, you need the following ports: ``` **On FreeBSD, you need the following ports:** ```
https://review.coreboot.org/c/flashrom/+/74216/comment/89e35e1a_9270c587 PS5, Line 59: On OpenBSD, you need the following ports: ``` **On OpenBSD, you need the following ports:** ```
https://review.coreboot.org/c/flashrom/+/74216/comment/0708c7be_0b5f155a PS5, Line 64: To compile on Linux, use:: ``` **To compile on Linux, use**:: ```
https://review.coreboot.org/c/flashrom/+/74216/comment/326ed1d3_f4523392 PS5, Line 68: To compile on FreeBSD, OpenBSD or DragonFly BSD, use:: ``` **To compile on FreeBSD, OpenBSD or DragonFly BSD, use**:: ```
https://review.coreboot.org/c/flashrom/+/74216/comment/a451613b_57e8a47b PS5, Line 72: To compile on Nexenta, use:: ``` **To compile on Nexenta, use**:: ```
https://review.coreboot.org/c/flashrom/+/74216/comment/ce212de2_40046553 PS5, Line 76: To compile on Solaris, use:: ``` **To compile on Solaris, use**:: ```
https://review.coreboot.org/c/flashrom/+/74216/comment/837a4add_ee3fdcf5 PS5, Line 80: To compile on NetBSD (with pciutils, libftdi, libusb installed in /usr/pkg/), use:: ``` **To compile on NetBSD (with pciutils, libftdi, libusb installed in /usr/pkg/), use**:: ```
https://review.coreboot.org/c/flashrom/+/74216/comment/0b66e236_6ae5b8ed PS5, Line 84: To compile and run on Darwin/Mac OS X: ``` **To compile and run on Darwin/Mac OS X:** ```
https://review.coreboot.org/c/flashrom/+/74216/comment/c9982ba4_2a1b99ba PS5, Line 89: To cross-compile on Linux for DOS: ``` **To cross-compile on Linux for DOS**: ```
https://review.coreboot.org/c/flashrom/+/74216/comment/f25539d6_0e12f19b PS5, Line 138: To cross-compile on Linux for Windows: ``` **To cross-compile on Linux for Windows:** ```
https://review.coreboot.org/c/flashrom/+/74216/comment/b47b73ef_f1482d5f PS5, Line 152: Processor architecture dependent features: ``` **Processor architecture dependent features:** ```
https://review.coreboot.org/c/flashrom/+/74216/comment/e036847c_1d69538a PS5, Line 158: Compiler quirks: ``` **Compiler quirks:** ```
https://review.coreboot.org/c/flashrom/+/74216/comment/ff14ad42_0950dc7e PS5, Line 164: Bindings: ``` **Bindings:** ```
https://review.coreboot.org/c/flashrom/+/74216/comment/1ab6671d_0f854486 PS5, Line 197: 'make export' ``` ``make export`` ```
https://review.coreboot.org/c/flashrom/+/74216/comment/62ccec29_1a2015f5 PS5, Line 203: 'make tarball' ``` ``make tarball`` ```