diff options
| author | Anup Patel <anup.patel@wdc.com> | 2020-05-06 12:16:48 +0530 |
|---|---|---|
| committer | Anup Patel <anup@brainfault.org> | 2020-05-07 09:46:22 +0530 |
| commit | c2286b6f042d80ccd6b047421570d59967568d3f (patch) | |
| tree | 2a2171d7bd2cb9601611c82b14805dad97fc8f31 | |
| parent | dfd9dd67dcac5d0cb639988e4420ab82516ba8be (diff) | |
docs: Fix ordering of pages in table of contents
Currently, all markdown pages are randomly arranged in table of
contents so to fix this we treat top-level README.md as mainpage
and enable Doxygen TREEVIEW.
Also, there should not be any text before title of a markdown
page so we move project copyright as separate section in top-level
README.md.
Signed-off-by: Anup Patel <anup.patel@wdc.com>
Reviewed-by: Atish Patra <atish.patra@wdc.com>
| -rw-r--r-- | README.md | 69 | ||||
| -rw-r--r-- | docs/doxygen.cfg | 2 |
2 files changed, 37 insertions, 34 deletions
@@ -1,9 +1,41 @@ -Copyright (c) 2019 Western Digital Corporation or its affiliates -and other contributors. - -RISC-V Open Source Supervisor Binary Interface (OpenSBI) +RISC-V Open Source Supervisor Binary Interface (OpenSBI) {#mainpage} ======================================================== +Copyright and License +--------------------- + +The OpenSBI project is copyright (c) 2019 Western Digital Corporation +or its affiliates and other contributors. + +It is distributed under the terms of the BSD 2-clause license +("Simplified BSD License" or "FreeBSD License", SPDX: *BSD-2-Clause*). +A copy of this license with OpenSBI copyright can be found in the file +[COPYING.BSD]. + +All source files in OpenSBI contain the 2-Clause BSD license SPDX short +identifier in place of the full license text. + +``` +SPDX-License-Identifier: BSD-2-Clause +``` + +This enables machine processing of license information based on the SPDX +License Identifiers that are available on the [SPDX] web site. + +OpenSBI source code also contains code reused from other projects as listed +below. The original license text of these projects is included in the source +files where the reused code is present. + +* The libfdt source code is disjunctively dual licensed + (GPL-2.0+ OR BSD-2-Clause). Some of this project code is used in OpenSBI + under the terms of the BSD 2-Clause license. Any contributions to this + code must be made under the terms of both licenses. + +See also the [third party notices] file for more information. + +Introduction +------------ + The **RISC-V Supervisor Binary Interface (SBI)** is the recommended interface between: @@ -171,35 +203,6 @@ export PLATFORM_RISCV_XLEN=32 will generate 32-bit OpenSBI images. And vice vesa. -License -------- - -OpenSBI is distributed under the terms of the BSD 2-clause license -("Simplified BSD License" or "FreeBSD License", SPDX: *BSD-2-Clause*). -A copy of this license with OpenSBI copyright can be found in the file -[COPYING.BSD]. - -All source files in OpenSBI contain the 2-Clause BSD license SPDX short -identifier in place of the full license text. - -``` -SPDX-License-Identifier: BSD-2-Clause -``` - -This enables machine processing of license information based on the SPDX -License Identifiers that are available on the [SPDX] web site. - -OpenSBI source code also contains code reused from other projects as listed -below. The original license text of these projects is included in the source -files where the reused code is present. - -* The libfdt source code is disjunctively dual licensed - (GPL-2.0+ OR BSD-2-Clause). Some of this project code is used in OpenSBI - under the terms of the BSD 2-Clause license. Any contributions to this - code must be made under the terms of both licenses. - -See also the [third party notices] file for more information. - Contributing to OpenSBI ----------------------- diff --git a/docs/doxygen.cfg b/docs/doxygen.cfg index 52346be..f32ada1 100644 --- a/docs/doxygen.cfg +++ b/docs/doxygen.cfg @@ -1445,7 +1445,7 @@ DISABLE_INDEX = NO # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. |