Commit Graph

9 Commits

Author SHA1 Message Date
Xinyun Liu e141150e4c doc: Fix AcrnGT broken API doc due to kernel upgrade
* interface name changed
* missing kernel doc comment in kernel source code

Tracked-On: #1511

Signed-off-by: Xinyun Liu <xinyun.liu@intel.com>
2018-10-29 09:20:43 -07:00
Geoffroy Van Cutsem 047f4e90a2 Documentation: update to AcrnGT official name
Update the ACRN documentation to use the official name of GVT-g
in ACRN to "AcrnGT" (ACRN-GT was previously widely used).

Also update the few occurences of "GVT-G" to "GVT-g" to be
consistent across our documentation. This includes a couple of
file name updates.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-09-06 21:51:23 -07:00
David B. Kinder 6d2553532a doc: fix doc errors from acrn_vhm_mm.h API changes
API changes to acrn-kernel/include/linux/vhm/acrn_vhm_mm.h in
https://github.com/projectacrn/acrn-kernel/pull/48 renamed functions
that were referenced in the GTG-g_api.rst document, causing the
documentation build to fail.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-31 09:47:46 -07:00
David B. Kinder 53a5941b99 doc: add GVT-G porting guide
Transcode, review, and publish GVT-G porting guide documentation. Merged
glossary entries, added anchor links in GVT-g_api for referencing from
this document.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-26 14:08:57 -07:00
Xinyun Liu 0631473bfc [doc] Add API document for ACRN-GT
This is API part of  API-GVT-g high level design doc.

Signed-off-by: Xinyun Liu <xinyun.liu@intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Reviewed-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-18 09:17:31 -07:00
David B. Kinder b170e295a7 doc: general edit for typos
Fix typos and misspellings, and tweak CSS for spacing before lists.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder ba121731b2 doc: add Technical intro doc
Add the "Introduction of Project Acorn" doc.

Also adds improvements to the doc generation processes, content styles,
removed doxygen-generated API material.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:29 +08:00
David B. Kinder dce61618dc doc: organizational and look improvements
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00
David B. Kinder d7938f8ca8 doc: initial doc commit
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00