diff options
| author | Mukesh Ojha <mukesh02@linux.vnet.ibm.com> | 2016-08-07 19:03:22 +0530 |
|---|---|---|
| committer | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-08-09 17:34:12 +1000 |
| commit | 17196ef852da29a3bcfde86448ce3d1c8ec081fc (patch) | |
| tree | 243bdc3e07bf330ac29aaad282afcd10ef46afff /doc | |
| parent | 3abf093bb02ac8f580cb555e1f0867f190bfa54a (diff) | |
| download | skiboot-17196ef852da29a3bcfde86448ce3d1c8ec081fc.zip skiboot-17196ef852da29a3bcfde86448ce3d1c8ec081fc.tar.gz skiboot-17196ef852da29a3bcfde86448ce3d1c8ec081fc.tar.bz2 | |
doc : Typos correction, case conversion, and replaces .txt with .rst
uncomppressed -> uncompressed
fatten -> flatten
weather -> whether
.txt -> .rst
Signed-off-by: Mukesh Ojha <mukesh02@linux.vnet.ibm.com>
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/opal-spec.rst | 12 | ||||
| -rw-r--r-- | doc/overview.rst | 6 |
2 files changed, 9 insertions, 9 deletions
diff --git a/doc/opal-spec.rst b/doc/opal-spec.rst index eca8472..770b605 100644 --- a/doc/opal-spec.rst +++ b/doc/opal-spec.rst @@ -100,7 +100,7 @@ to as skiroot. The OPAL Specification explicitly allows variation in this payload. A requirement of the payload is that it MUST support loading and booting -an uncomppressed vmlinux Linux kernel. +an uncompressed vmlinux Linux kernel. [**TODO**: expand on what this actually means] An OPAL system MUST pass a device tree to the host kernel. @@ -119,7 +119,7 @@ Explicitly not covered by the OPAL Specification: Explicitly allowed: * Replacing the payload with something of equal/similar functionality - (weather replacing skiroot with an implementation of Zork would be compliant + (whether replacing skiroot with an implementation of Zork would be compliant is left as an exercise for the reader) Payload Environment @@ -173,8 +173,8 @@ under other platforms. For example, a single Linux kernel can be built to boot under OPAL and under PowerVM or qemu pseries machine type. The root node of the device tree MUST have compatible = "ibm,powernv". -See doc/device-tree.txt for more details -[TODO: make doc/device-tree.txt better] +See doc/device-tree.rst for more details +[TODO: make doc/device-tree.rst better] The presence of the "/ibm,opal" entry in the device tree signifies running under OPAL. Additionally, the "/ibm,opal" node MUST have a compatibile property @@ -210,13 +210,13 @@ about the firmware environment. The version property is a textual representation of the OPAL version. For example, it may be "skiboot-4.1" or other versioning described -in more detail in doc/versioning.txt +in more detail in doc/versioning.rst OPAL log -------- -OPAL implementations SHOULD have an in memory log where informational and +OPAL implementation SHOULD have an in memory log where informational and error messages are stored. If present it MUST be human readable and text based. There is a separate facility (Platform Error Logs) for machine readable errors. diff --git a/doc/overview.rst b/doc/overview.rst index e324ca2..e72599d 100644 --- a/doc/overview.rst +++ b/doc/overview.rst @@ -1,7 +1,7 @@ -skiboot overview +Skiboot overview ================ -skiboot is firmware, loaded by the FSP. Along with loading the bootloader, +Skiboot is firmware, loaded by the FSP. Along with loading the bootloader, it provides some runtime services to the OS (typically Linux). Source layout @@ -51,7 +51,7 @@ Essentially, we do this by doing an atomic fetch and inc and whoever gets 0 gets to be the master. When we enter skiboot we also get a memory location in a register which -is the location of a device tree for the system. We fatten out the device +is the location of a device tree for the system. We flatten out the device tree, turning offsets into real pointers and manipulating it where needed. We re-flatten the device tree before booting the OS (Linux). |