Patrick Georgi submitted this change.
util/chromeos: revise description for more utility scripts in future
The description.md and README.md was explicitly made for downloading or
extracting some resources, but we need to add more Chrome OS related
scripts soon; so the description should be revised.
Also changed README.md for better markdown style, for example
- Use #, ## to replace the old '-' headers
- Use code format for file names
- Use code block for example of shell execution
Change-Id: Icc3677fa318b03f4aee1b0f5fb13b2095f2afe64
Signed-off-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/35664
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Patrick Georgi <pgeorgi@google.com>
---
M util/chromeos/README.md
M util/chromeos/description.md
2 files changed, 16 insertions(+), 15 deletions(-)
diff --git a/util/chromeos/README.md b/util/chromeos/README.md
index 3c3d721..7a3897d 100644
--- a/util/chromeos/README.md
+++ b/util/chromeos/README.md
@@ -1,27 +1,28 @@
-Chrome OS binary extraction
-===========================
+# Chrome OS Scripts
-These scripts can be used to extract System Agent reference code
-and other blobs (e.g. mrc.bin, refcode, VGA option roms) from a
-Chrome OS recovery image.
+These scripts can be used to access or generate Chrome OS resources, for example
+to extract System Agent reference code and other blobs (e.g. `mrc.bin`, refcode,
+VGA option roms) from a Chrome OS recovery image.
-crosfirmware.sh
----------------
+## crosfirmware.sh
-crosfirmware.sh downloads a Chrome OS recovery image from the recovery
+`crosfirmware.sh` downloads a Chrome OS recovery image from the recovery
image server, unpacks it, extracts the firmware update shell archive,
extracts the firmware images from the shell archive.
To download all Chrome OS firmware images, run
+```
$ ./crosfirmware.sh
+```
To download, e.g. the Panther firmware image, run
+```
$ ./crosfirmware.sh panther
+```
-extract_blobs.sh
-----------------
+## extract_blobs.sh
-extract_blobs.sh extracts the blobs from a Chrome OS firmware image.
+`extract_blobs.sh` extracts the blobs from a Chrome OS firmware image.
Right now it will produce the ME firmware blob, IFD, VGA option rom,
-and mrc.bin
+and `mrc.bin`.
diff --git a/util/chromeos/description.md b/util/chromeos/description.md
index d2da577..840e589 100644
--- a/util/chromeos/description.md
+++ b/util/chromeos/description.md
@@ -1,3 +1,3 @@
-These scripts can be used to extract System Agent reference code and
-other blobs (e.g. mrc.bin, refcode, VGA option roms) from a Chrome OS
-recovery image. `C`
+These scripts can be used to access Chrome OS resources, for example to extract
+System Agent reference code and other blobs (e.g. mrc.bin, refcode, VGA option
+roms) from a Chrome OS recovery image. `C`
To view, visit change 35664. To unsubscribe, or for help writing mail filters, visit settings.