| OLD | NEW |
| (Empty) | |
| 1 |
| 2 The recovery tool assists the user in creating a bootable USB drive that can |
| 3 recover a non-functional Chromium OS device. It generally operates in three |
| 4 steps. |
| 5 |
| 6 1. Download a config file from a known URL. This file describes the |
| 7 available images and where they can be found. |
| 8 |
| 9 2. Ask the user to select the appropriate image, download it, and verify |
| 10 that it matches what the config file describes. |
| 11 |
| 12 3. Ask the user to select a USB drive, and write the recovery image to it. |
| 13 |
| 14 |
| 15 Here's the format of the config file: |
| 16 |
| 17 The config file is a text file containing at least two paragraphs or |
| 18 stanzas, which are separated by at least one blank line. Lines beginning |
| 19 with '#' are completely ignored and do not count as blank lines. Non-blank |
| 20 lines must consist of a non-blank key and non-blank value separated by a '=' |
| 21 with no spaces on either side. The key may not contain whitespace. The value |
| 22 may contain spaces, but all trailing whitespace is discarded. |
| 23 |
| 24 The first stanza must contain a key named "recovery_tool_version'. Its value |
| 25 must match the version of the recovery tool. If the value does not match, |
| 26 then the key 'recovery_tool_update', if it exists in the first stanza, |
| 27 should contain a string to display to the user. Regardless, if the version |
| 28 doesn't match, the recovery tool should exit. |
| 29 |
| 30 The second and remaining stanzas describe recovery images to put on the USB |
| 31 drive. |
| 32 |
| 33 For recovery_tool_version=1.0, each image stanza must contain: |
| 34 |
| 35 * One and only one of these keys: |
| 36 |
| 37 display_name - string to show to the user |
| 38 file - the name of the file to extract from the tarball |
| 39 size - size in bytes of the tarball |
| 40 |
| 41 * One or more of these keys: |
| 42 |
| 43 url - where to find the tarball to download |
| 44 |
| 45 * One or both of these keys: |
| 46 |
| 47 md5 - md5sum of the tarball |
| 48 sha1 - sha1sum of the tarball |
| 49 |
| 50 * Any other keys are informational only and are not used by the recovery tool. |
| 51 |
| 52 |
| 53 |
| 54 NOTE: This is still in flux. Possible additional keys are |
| 55 |
| 56 hwid |
| 57 name |
| 58 channel |
| OLD | NEW |