From cd2dfdc870ed3a03c3afc28e25f770fada0a396e Mon Sep 17 00:00:00 2001
From: Atish Patra <atish.patra@wdc.com>
Date: Tue, 18 Jun 2019 14:54:07 -0700
Subject: docs: Update docs as per new static library.
Signed-off-by: Atish Patra <atish.patra@wdc.com>
Acked-by: Anup Patel <anup.patel@wdc.com>
---
docs/contributing.md | 3 ++-
docs/library_usage.md | 6 +++++-
docs/platform_guide.md | 2 +-
3 files changed, 8 insertions(+), 3 deletions(-)
(limited to 'docs')
diff --git a/docs/contributing.md b/docs/contributing.md
index 7b9898f..9c2b3ba 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -24,7 +24,8 @@ Every submitted patch must have this tag.
followed by a description of the patch content. A blank line and the author
Signed-off-by tag must follow this description.
4. A commit subject line must start with a prefix followed by a ":". Common
-prefixes are for example "lib:", "platform:", "firmware:", "docs:" and "top:".
+prefixes are for example "lib:", "platform:", "firmware:", "docs:", "utils:"
+and "top:".
5. Maintainers should use "Rebase and Merge" when using GitHub to merge pull
requests to avoid creating unnecessary merge commits.
6. Maintainers should avoid creating branches directly in the main
diff --git a/docs/library_usage.md b/docs/library_usage.md
index 92d51f5..d765fa9 100644
--- a/docs/library_usage.md
+++ b/docs/library_usage.md
@@ -8,7 +8,11 @@ OpenSBI provides two types of static libraries:
hooks for the execution of this interface must be provided by the firmware or
bootloader linking with this library. This library is installed as
*<install_directory>/lib/libsbi.a*
-2. *libplatsbi.a* - An example platform-specific static library integrating
+2. *libsbiutils.a* - A static library that will contain all common code required
+ by any platform supported in OpenSBI. It will be built by default and included
+ in libplatsbi.a. This library is installed as
+ *<install_directory>/lib/libsbiutils.a*.
+3. *libplatsbi.a* - An example platform-specific static library integrating
*libsbi.a* with platform-specific hooks. This library is available only for
the platforms supported by OpenSBI. This library is installed as
*<install_directory>/platform/<platform_subdir>/lib/libplatsbi.a*
diff --git a/docs/platform_guide.md b/docs/platform_guide.md
index 53e9394..7920fac 100644
--- a/docs/platform_guide.md
+++ b/docs/platform_guide.md
@@ -30,7 +30,7 @@ Support for a new platform named *<xyz>* can be added as follows:
1. Create a directory named *<xyz>* under the *platform/* directory.
2. Create a platform configuration file named *config.mk* under the
*platform/<xyz>/* directory. This configuration file will provide
- compiler flags, select common drivers, and select firmware options.
+ compiler flags, and select firmware options.
3. Create a *platform/<xyz>/objects.mk* file for listing the
platform-specific object files to be compiled.
4. Create a *platform/<xyz>/platform.c* file providing a *struct sbi_platform*
--
cgit v1.2.3