forked from Mirrors/opensbi
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>
This commit is contained in:
69
README.md
69
README.md
@@ -1,9 +1,41 @@
|
|||||||
Copyright (c) 2019 Western Digital Corporation or its affiliates
|
RISC-V Open Source Supervisor Binary Interface (OpenSBI) {#mainpage}
|
||||||
and other contributors.
|
|
||||||
|
|
||||||
RISC-V Open Source Supervisor Binary Interface (OpenSBI)
|
|
||||||
========================================================
|
========================================================
|
||||||
|
|
||||||
|
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
|
The **RISC-V Supervisor Binary Interface (SBI)** is the recommended interface
|
||||||
between:
|
between:
|
||||||
|
|
||||||
@@ -171,35 +203,6 @@ export PLATFORM_RISCV_XLEN=32
|
|||||||
|
|
||||||
will generate 32-bit OpenSBI images. And vice vesa.
|
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
|
Contributing to OpenSBI
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
||||||
|
@@ -1445,7 +1445,7 @@ DISABLE_INDEX = NO
|
|||||||
# The default value is: NO.
|
# The default value is: NO.
|
||||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
# 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
|
# 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.
|
# doxygen will group on one line in the generated HTML documentation.
|
||||||
|
Reference in New Issue
Block a user