Change in coreboot[master]: util/chromeos: revise description for more utility scripts in future
Hung-Te Lin has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/35664 )
Change subject: util/chromeos: revise description for more utility scripts in future ......................................................................
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 --- M util/chromeos/README.md M util/chromeos/description.md 2 files changed, 16 insertions(+), 15 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/64/35664/1
diff --git a/util/chromeos/README.md b/util/chromeos/README.md index 3c3d721..e3ac34c 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..ca3d53e 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 +extracting System Agent reference code and other blobs (e.g. mrc.bin, refcode, +VGA option roms) from a Chrome OS recovery image. `C`
Furquan Shaikh has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/35664 )
Change subject: util/chromeos: revise description for more utility scripts in future ......................................................................
Patch Set 1: Code-Review+2
Patrick Georgi has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/35664 )
Change subject: util/chromeos: revise description for more utility scripts in future ......................................................................
Patch Set 1: Code-Review+1
(1 comment)
https://review.coreboot.org/c/coreboot/+/35664/1/util/chromeos/description.m... File util/chromeos/description.md:
https://review.coreboot.org/c/coreboot/+/35664/1/util/chromeos/description.m... PS1, Line 2: extracting extract
Hello Julius Werner, build bot (Jenkins), Patrick Georgi, Furquan Shaikh,
I'd like you to reexamine a change. Please visit
https://review.coreboot.org/c/coreboot/+/35664
to look at the new patch set (#2).
Change subject: util/chromeos: revise description for more utility scripts in future ......................................................................
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 --- M util/chromeos/README.md M util/chromeos/description.md 2 files changed, 16 insertions(+), 15 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/64/35664/2
Hung-Te Lin has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/35664 )
Change subject: util/chromeos: revise description for more utility scripts in future ......................................................................
Patch Set 2:
(1 comment)
https://review.coreboot.org/c/coreboot/+/35664/1/util/chromeos/description.m... File util/chromeos/description.md:
https://review.coreboot.org/c/coreboot/+/35664/1/util/chromeos/description.m... PS1, Line 2: extracting
extract
Done
Patrick Georgi has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/35664 )
Change subject: util/chromeos: revise description for more utility scripts in future ......................................................................
Patch Set 2: Code-Review+2
Patrick Georgi has submitted this change. ( https://review.coreboot.org/c/coreboot/+/35664 )
Change subject: util/chromeos: revise description for more utility scripts in future ......................................................................
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(-)
Approvals: build bot (Jenkins): Verified Patrick Georgi: Looks good to me, approved
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`
-
Furquan Shaikh (Code Review) -
Hung-Te Lin (Code Review)
-
Patrick Georgi (Code Review)