From 0d33a981ec19181c7f6448f90599f31dfd082994 Mon Sep 17 00:00:00 2001 From: Karsten Merker <merker@debian.org> Date: Sun, 5 May 2019 12:33:25 +0200 Subject: docs: miscellaneous documentation fixes and updates - fix some broken hyperlinks - add additional hyperlinks to references to external documents - reformat some paragraphs to keep lines under 80 characters - unify the enumeration style between different parts of the documentation - fix spelling/grammar mistakes - extend the copyright notice in README.md to be the same as the one in COPYING.BSD Signed-off-by: Karsten Merker <merker@debian.org> Reviewed-by: Atish Patra <atish.patra@wdc.com> --- docs/platform/platform.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'docs/platform') diff --git a/docs/platform/platform.md b/docs/platform/platform.md index 12efa81..2235b6a 100644 --- a/docs/platform/platform.md +++ b/docs/platform/platform.md @@ -1,11 +1,12 @@ OpenSBI Supported Platforms =========================== -OpenSBI currently supports the following virtual and hardware platforms. +OpenSBI currently supports the following virtual and hardware platforms: -* **QEMU RISC-V Virt Machine**: Platform support for QEMU *virt* virtual RISC-V - machine. This virtual machine is intended for RISC-V software development and - test. More details on this platform can be found in the file *[qemu_virt.md]*. +* **QEMU RISC-V Virt Machine**: Platform support for the QEMU *virt* virtual + RISC-V machine. This virtual machine is intended for RISC-V software + development and tests. More details on this platform can be found in the + file *[qemu_virt.md]*. * **QEMU SiFive Unleashed Machine**: Platform support for the *sifive_u* QEMU virtual RISC-V machine. This is an emulation machine of the HiFive Unleashed @@ -18,13 +19,14 @@ OpenSBI currently supports the following virtual and hardware platforms. *[sifive_fu540.md]*. * **Kendryte K210 SoC**: Platform support for the Kendryte K210 SoC used on - boards such as the Kendryte KD233 and Sipeed MAIX Dock boards. + boards such as the Kendryte KD233 or the Sipeed MAIX Dock. The code for these supported platforms can be used as example to implement support for other platforms. The *platform/template* directory also provides template files for implementing support for a new platform. The *object.mk*, -*config.mk* and *platform.c* template files provides enough comments to facilitate -the implementation. +*config.mk* and *platform.c* template files provides enough comments to +facilitate the implementation. [qemu_virt.md]: qemu_virt.md [qemu_sifive_u.md]: qemu_sifive_u.md +[sifive_fu540.md]: sifive_fu540.md -- cgit v1.2.3