diff options
| author | Anup Patel <anup.patel@wdc.com> | 2018-12-21 08:05:04 +0300 |
|---|---|---|
| committer | Anup Patel <anup@brainfault.org> | 2018-12-21 08:05:04 +0300 |
| commit | 089f70a1798b5c631e87eeb26b7eb2593571c63d (patch) | |
| tree | 921799751ffa8296e19ca34eff589daa2fd38d8e /README.md | |
| parent | 6f02b6938f8e607d38ee8de5a59581d554af0d3f (diff) | |
| download | opensbi-089f70a1798b5c631e87eeb26b7eb2593571c63d.tar.xz | |
top: Rename "plat" to "platform" everywhere
This patch renames "plat" to "platform" everywhere for better
readablility.
Signed-off-by: Anup Patel <anup.patel@wdc.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 8 insertions, 8 deletions
@@ -32,8 +32,8 @@ For cross-compiling, please ensure that CROSS_COMPILE environment variable is set before starting build system. The libplatsbi.a and firmwares are optional and only built when -`PLAT=<platform_subdir>` parameter is specified to top-level make. -(**NOTE**: `<platform_subdir>` is sub-directory under plat/ directory) +`PLATFORM=<platform_subdir>` parameter is specified to top-level make. +(**NOTE**: `<platform_subdir>` is sub-directory under platform/ directory) To build and install Generic OpenSBI library do the following: @@ -50,17 +50,17 @@ To build and install platform specific OpenSBI library and firmwares do the following: 1. Build **libsbi, libplatsbi, and firmwares**: -`make PLAT=<platform_subdir>` +`make PLATFORM=<platform_subdir>` OR -`make PLAT=<platform_subdir> O=<build_directory>` +`make PLATFORM=<platform_subdir> O=<build_directory>` 2. Install **libsbi, headers, libplatsbi, and firmwares**: -`make PLAT=<platform_subdir> install` +`make PLATFORM=<platform_subdir> install` OR -`make PLAT=<platform_subdir> I=<install_directory> install` +`make PLATFORM=<platform_subdir> I=<install_directory> install` In addition, we can also specify platform specific command-line options to top-level make (such as `PLAT_<xyz>` or `FW_<abc>`) -which are described under `docs/plat/<platform_name>.md` OR +which are described under `docs/platform/<platform_name>.md` OR `docs/firmware/<firmware_name>.md`. Documentation @@ -71,7 +71,7 @@ manner: * `docs/platform_guide.md` - Guidelines for adding new platform support * `docs/library_usage.md` - Guidelines for using static library -* `docs/plat/<platform_name>.md` - Documentation for `<platform_name>` platform +* `docs/platform/<platform_name>.md` - Documentation for `<platform_name>` platform * `docs/firmware/<firmware_name>.md` - Documentation for firmware `<firmware_name>` We also prefer source level documentation, so wherever possible we describe |