opensbi.git/docs/doxygen.cfg, branch master

docs: Add documentation about tests and SBIUnit

2024-03-10T04:28:57Z

This patch contains the documentation for SBIUnit. It describes: - What is SBIUnit - Simple test writing scenario - How we can cover static functions - How we can "mock" structures in order to test the functions which operate on them - SBIUnit API Reference Signed-off-by: Ivan Orlov Reviewed-by: Andrew Jones

docs: Add OpenSBI DT configuration guide.

2024-02-20T10:35:21Z

This patch add docs/opensbi_config.md which describes the "/chosen/opensbi-config" DT node and properties Signed-off-by: Cheng Yang Reviewed-by: Anup Patel

docs: Add initial documentation for domain support

2020-10-21T06:59:36Z

We add initial documentation for OpenSBI domain support to help RISC-V platform vendors achieve system-level partitioning. Signed-off-by: Anup Patel Reviewed-by: Atish Patra

docs: Use doxygen config to mark the main page

2020-06-08T11:32:41Z

The doxygen config option "USE_MDFILE_AS_MAINPAGE" can be used to set the main page in doxygen generated pdf. This allows us to remove the "#mainpage" from the README file which markdown doesn't parse. Signed-off-by: Atish Patra Reviewed-by: Anup Patel

docs: Fix ordering of pages in table of contents

2020-05-07T04:16:22Z

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 Reviewed-by: Atish Patra

docs: Add platform requirements document

2020-05-07T04:15:52Z

We add platform requirements document to clarify OpenSBI expectations from a RISC-V platform. Signed-off-by: Anup Patel Reviewed-by: Atish Patra Reviewed-by: Bin Meng

docs: miscellaneous documentation fixes and updates

2019-05-06T05:35:33Z

- fix some broken hyperlinks - add additional hyperlinks to references to external documents - reformat some paragraphs to keep lines under 80 characters - unify the enumeration style between different parts of the documentation - fix spelling/grammar mistakes - extend the copyright notice in README.md to be the same as the one in COPYING.BSD Signed-off-by: Karsten Merker Reviewed-by: Atish Patra

docs: Update doxygen config file

2019-01-30T06:44:30Z

This patch updates doxygen config file to include docs/platform_guide.md and docs/library_usage.md in generated PDF document. Signed-off-by: Anup Patel

docs: Add OpenSBI version to doxygen.cfg

2019-01-22T06:10:15Z

The PDF document generated by doxygen should have OpenSBI version hence this patch adds OpenSBI version to doxygen.cfg. Signed-off-by: Anup Patel

Makefile: Add make targets to build and install documentation

2019-01-16T05:55:25Z

This patch extends top-level makefile to build and install documentation. The 'docs' make target is for building the documentation PDF whereas 'install_docs' make target is for installing the documentation PDF. Signed-off-by: Anup Patel