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>
This commit is contained in:
Anup Patel
2018-12-21 10:35:04 +05:30
committed by Anup Patel
parent 6f02b6938f
commit 089f70a179
33 changed files with 92 additions and 92 deletions

View File

@@ -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