OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity
acrn-hypervisor/doc/developer-guides/index.rst

33 lines
523 B
ReStructuredText
Raw Normal View History

doc: reorganize documentation We've been expanding documentation, and now need to organize things a bit cleaner and separate content into new major folders: Introduction, Getting Started, User Guides, Developer Guides, Tutorials, and Release notes.. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-06-28 22:55:57 +08:00
.. _developer-guides:
Developer Guides
################
.. toctree::
:maxdepth: 1
doc: reorganize HLD docs Reorganize the high-level design docs to align with a work-in-progress HLD document. Migrate previous web content (and images) into the new organization. From here we'll continue inclusion of new design chapters as they're reviewed and edited. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-05 07:39:40 +08:00
hld/index
primer
GVT-g-porting
trusty
doc: add l1tf document Add ACRN L1TF readme document Tracked-On: #1672 Signed-off-by: Jason Chen CJ <jason.cj.chen@intel.com> Signed-off-by: Tian, Kevin <kevin.tian@intel.com>
2018-09-01 21:51:39 +08:00
l1tf
doc: add a document on considerations and current status of hypervisor modularization To kick off the efforts on modularization, this patch introduces a document describing the goals and general principles of modular design as well as a brief introduction on the current status of component/module decomposition. A detailed assignment of source files to components will be added in the future. v2 -> v3: * Expand mailing list address in the doc v1 -> v2: * Add more description on complexity measures, cyclic dependency avoidance, and the reverse dependency of boot on hypervisor initialzation. * Fix typos. Tracked-On: #1842 Signed-off-by: Junjie Mao <junjie.mao@intel.com>
2018-11-21 19:15:06 +08:00
modularity
doc: reorganize HLD docs Reorganize the high-level design docs to align with a work-in-progress HLD document. Migrate previous web content (and images) into the new organization. From here we'll continue inclusion of new design chapters as they're reviewed and edited. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-05 07:39:40 +08:00
../api/index
../reference/kconfig/index
doc: reorganize doc tree With the addition of more HLD documents, the developer-guides index was getting too busy, so push the HLD documents down a level. Also, the supported hardware document is buried in the getting started section and hard to find, so promote it. Trusty isn't really supported (yet) so drop it from the TOC for now. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-17 06:01:25 +08:00
doc: reorganize documentation We've been expanding documentation, and now need to organize things a bit cleaner and separate content into new major folders: Introduction, Getting Started, User Guides, Developer Guides, Tutorials, and Release notes.. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-06-28 22:55:57 +08:00
Contributing to the project
***************************
As an open-source project, we welcome and encourage the community to
submit patches for code, documentation, tests, and more, directly to the
project.
.. toctree::
:maxdepth: 1
doc: reorganize HLD docs Reorganize the high-level design docs to align with a work-in-progress HLD document. Migrate previous web content (and images) into the new organization. From here we'll continue inclusion of new design chapters as they're reviewed and edited. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-05 07:39:40 +08:00
contribute_guidelines
doc: initial draft of ACRN coding guidelines This patch introduces an initial draft of ACRN coding guidelines. We will update this document gradually to support ACRN achieve MISRA-C compliance. Tracked-On: #861 Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2018-12-13 17:11:57 +08:00
coding_guidelines
doc: reorganize HLD docs Reorganize the high-level design docs to align with a work-in-progress HLD document. Migrate previous web content (and images) into the new organization. From here we'll continue inclusion of new design chapters as they're reviewed and edited. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-05 07:39:40 +08:00
doc_guidelines
graphviz