Commit Graph

22 Commits

Author SHA1 Message Date
David B. Kinder 0bd384d41b doc: fix all headings to use title case
While we hoped to make the headings consistent over time while doing
other edits, we should instead just make the squirrels happy and do them
all at once or they'll likely never be made consistent.

A python script was used to find the headings, and then a call to
https://pypi.org/project/titlecase to transform the title.  A visual
inspection was used to tweak a few unexpected resulting titles.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-02-13 12:37:49 -08:00
David B. Kinder a26a663041 doc: add mmio-dev-passthrough to TOC
Doc was merged but not included in the TOC (CI indicated a pass on that
PR even though doc build failed).  This fixes that undetected error.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-07-28 14:38:04 -07:00
yuhong.tao@intel.com 9d327bfdf8 Doc: HLD for Split-locked Access Handling
Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
2020-04-28 11:18:53 -07:00
David B. Kinder 1e8269b5f7 doc: fix misspellings
Fix misspellings missed during regular reviews

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-10 08:58:54 -07:00
Vijay Dhanraj a2763ab7f0 doc: Add MBA documentation and update doc for CAT
This patch updates CAT documentation as well as adds
documentation support for newly added MBA feature.

Signed-off-by: Vijay Dhanraj <vijay.dhanraj@intel.com>
2020-03-27 16:58:20 -04:00
yuhong.tao@intel.com ca9adf7ddd doc: add HLD for CAT
The hld of resource director technology, RDT. Should have CAT and
MBA. This is for CAT.

Signed-off-by: Tao Yuhong <yuhong.tao@intel.com>
2019-10-28 18:04:04 -04:00
Jason Chen CJ 0b00bbd65f document: update HLD for vm management
add VM state transition, and make this chapter into
part of hypervisor hld, the user level vm management
should be introduced in ACRN tools.

Tracked-On: #3882
Signed-off-by: Jason Chen CJ <jason.cj.chen@intel.com>
2019-10-25 10:31:51 -04:00
David B. Kinder e2d3653976 doc: continue doc restructuring
Changing the folder structure will cause too many broken links for
external references (from other sites). So, let's put the content back
where it was before the reorg, and instead use the new persona-based
navigation to point to documents in the original locations.

Also, introduce redirects for some documents that no longer exits.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-01 14:07:22 -07:00
David B. Kinder 11d4f4159f doc: Reorganize documentation site content
Take the existing ACRN technical documentation and reorganize its
presentation to be persona and use-case based, in preparation for adding
new scenario/use-case based architecture introduction and getting
started documents.

Introduce a more graphical home page and theme color tweaks.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-31 18:29:22 -07:00
David B. Kinder 32a7b4f179 doc: add IOC virtualization HLD
Convert and edit IOC virtualization doc to add to ACRN documentation.
Add a note that IOC virtualization is not supported on the NUC or UP2
platforms.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-02-28 11:55:32 -08:00
David B. Kinder 117b71e6af doc: add partition mode hld
Partition mode HLD content added to hypervisor hld.
Add target links in referenced docs.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-15 10:35:38 -08:00
David B. Kinder ac5b46eba5 doc: update rest of hypervisor HLD sections
Transcode, edit, and upload HLD 0.7 section 3.10 (PM in hypervisor),
3.11 (Console, shell, vUART), 3.12 (Hypercall/VHM upcall), and
3.13 (Compile-time config)

Also scan/replace UTF-8 punctuation missed in previous PRs.

Add anchor targets in referenced docs.

Tracked-on: #1648

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-30 11:20:09 -07:00
David B. Kinder bf7b1cf744 doc: update HLD Device passthrough
transcode, edit, and upload HLD 0.7 section 3.9 (Device passthrough)

Tracked-on: #1645

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-29 16:32:32 -07:00
David B. Kinder 7c192db1ba doc: update HLD VT-d
transcode, edit, and upload HLD 0.7 section 3.8 (VT-d)

Tracked-on: #1643

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-29 13:34:01 -07:00
David B. Kinder dc7df1cd0f doc: update HLD Virtual Interrupt
transcode, edit, and upload HLD 0.7 section 3.7 (Virtual Interrupt)
Add target references in other docs as needed.

Tracked-on: #1623

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-26 16:46:49 -07:00
David B. Kinder 1c54734f8b doc: update HLD Timer section
transcode, edit, and upload HLD 0.7 section 3.6 (Timer)
Also, fix the hv sections file names to be consistent.

Tracked-on: #1623

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-26 15:12:45 -07:00
David B. Kinder 70e13bf8f4 doc: update interrupt hld section
Transcode, edit, and upload HLD 0.7 sections 3.5 (Physical Interrupts)

Tracked-on: #1610

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-25 16:44:41 -07:00
David B. Kinder f84547cad2 doc: move docs to match HLD 0.7 org
I/O emulation section was in a different place than in the HLD 0.7 doc

Tracked-on: #1592
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-25 14:09:30 -07:00
David B. Kinder acc51877f1 doc: merge static core with cpu virt
Update the converted HLD 0.7 section 3.2 with a previously converted
static partitioning document (instead of a separate doc for this topic).

Tracked-on: #1533

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-19 16:09:19 -07:00
David B. Kinder e01f47778a doc: HV startup and CPU virtualization sections
transcode, edit, and upload HLD 0.7 sections 3.1 and 3.2

Tracked-on: #1533

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-19 15:46:38 -07:00
David B. Kinder e7b63aec9d doc: add static core partitioning doc
Update HLD with the static core partitioning doc

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-15 12:45:16 -07:00
David B. Kinder 1e38544112 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 16:08:15 -07:00