Commit Graph

1357 Commits

Author SHA1 Message Date
Amy Reyes
58e27983b4 doc: terminology cleanup in partition mode
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-12 15:22:51 -08:00
Amy Reyes
6c5035f9c1 doc: terminology cleanup in design guidelines
- Replace SOS or Service OS with Service VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-12 15:08:57 -08:00
jackwhich
279f129f2d doc: Update nuc11 partitioned document and Scenario xml
Rename logical_partition to partitioned;
Use acrn hypervisor commit instead of tag v2.6;
Add partitioned.xml ramdisk parameter.

Tracked-On: #6709
Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2021-11-12 16:25:21 +08:00
Amy Reyes
6023388e79 doc: terminology cleanup in IOC virt
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-11 15:29:34 -08:00
Amy Reyes
33a205c913 doc: terminology cleanup in trusty doc
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-10 13:09:07 -08:00
Amy Reyes
e66d65152c doc: terminology cleanup in What Is ACRN, HLD intro
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-09 14:01:17 -08:00
Amy Reyes
6695080182 doc: terminology cleanup in DM params
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-09 10:19:07 -08:00
Amy Reyes
a68d9266a7 doc: terminology cleanup in nvmx tutorial
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-09 10:17:55 -08:00
David B. Kinder
6ae241d398 doc: fix git clone and misspelling
It's recommended we always use the .git extension when referring to the
git repo when cloning.  Fix that in the GSG.

Also, fix a misspelling in the hld-power-management doc.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-11-09 09:55:59 -08:00
Amy Reyes
2ae8a468f9 Update AGL and TME links per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 15:31:41 -08:00
Amy Reyes
812cd3e6de doc: terminology cleanup in HLD security
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 15:31:41 -08:00
Amy Reyes
fe6adb606c Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:04:00 -08:00
Amy Reyes
47a3912e7c Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:04:00 -08:00
Amy Reyes
7ac09dda43 doc: terminology cleanup in HLD overview
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Replace platform names with link to Support Hardware page
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:04:00 -08:00
Amy Reyes
2fbe9ccb42 Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:02:26 -08:00
Amy Reyes
dfe18717ed doc: terminology cleanup in HLD startup
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:02:26 -08:00
Amy Reyes
a11c4592c3 Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:00:30 -08:00
Amy Reyes
b662ea1f08 doc: terminology cleanup in HLD virtio
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Replace VHM with HSM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 11:00:30 -08:00
Amy Reyes
602a380e03 doc: Update VT-d spec link
Publisher of this document confirmed that VT-d spec link should be updated, and the existing link will be EOL.

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-08 10:56:12 -08:00
Amy Reyes
546de2bfa9 Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-04 14:14:42 -07:00
Amy Reyes
ae9c6e3232 doc: Update virtio network in launch script
- Update description of virtio network setting in launch script to match:

https://projectacrn.github.io/latest/user-guides/acrn-dm-parameters.html
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-04 14:14:42 -07:00
David B. Kinder
8fb3ca83a6 doc: update last updated information on page footers
The "Last Updated" footer shows the date the page was published, not
when the content was last updated. This has caused readers some
confusion.  Update the footer with the date of the git commit that last
updated the document, and clarify with both the last modified and
published dates in the footer, something like this:

   Last modified: Aug 19, 2021. Published: Nov 03, 2021.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-11-03 19:10:56 -07:00
David B. Kinder
603780e6ef doc: draft release notes for v2.7
Start documenting the major changes to v2.7, in particular the UOS/SOS
term changes that impact the APIs and documentation, and the scenario name changes.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-11-02 18:04:26 -07:00
David B. Kinder
fb226e2938 doc: clean up UOS/SOS and scenario names in glossary
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-11-02 18:04:06 -07:00
David B. Kinder
0bcb66e94e doc: tweak CSS for Sphinx/Breathe API documents
Words in the function prototypes looked run together making it hard to
read, so tweak the CSS to add a bit of padding.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-11-02 17:28:02 -07:00
Liu Long
3f4ea38158 ACRN: misc: Unify terminology for service vm/user vm
Rename SOS_VM type to SERVICE_VM
rename UOS to User VM in XML description
rename uos_thread_pid to user_vm_thread_pid
rename devname_uos to devname_user_vm
rename uosid to user_vmid
rename UOS_ACK to USER_VM_ACK
rename SOS_VM_CONFIG_CPU_AFFINITY to SERVICE_VM_CONFIG_CPU_AFFINITY
rename SOS_COM to SERVICE_VM_COM
rename SOS_UART1_VALID_NUM" to SERVICE_VM_UART1_VALID_NUM
rename SOS_BOOTARGS_DIFF to SERVICE_VM_BOOTARGS_DIFF
rename uos to user_vm in launch script and xml

Tracked-On: #6744
Signed-off-by: Liu Long <long.liu@linux.intel.com>
Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-11-02 10:00:55 +08:00
David B. Kinder
2554c8f8cc doc: fix broken links
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-29 11:33:02 -07:00
Amy Reyes
8587f73919 Remove prompts in commands
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:40:28 -07:00
Amy Reyes
377a3b9d49 Update per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:40:28 -07:00
Amy Reyes
a5a4c112d1 doc: terminology cleanup in using_grub.rst
- Replace SOS with Service VM
- Replace guest with VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:40:28 -07:00
Amy Reyes
6f92eef2be Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:39:57 -07:00
Amy Reyes
208fcece20 Replace ACRNSOS with ServiceVM in commands
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:39:57 -07:00
Amy Reyes
a2dae1e1a9 Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:39:57 -07:00
Amy Reyes
8d572e7319 doc: terminology cleanup in acrn_on_qemu.rst
- Replace SOS with Service VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:39:57 -07:00
Amy Reyes
6d61c2dfff Updated per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:32:11 -07:00
Amy Reyes
d868f9fece doc: terminology cleanup in hv-vt-d.rst
- Replace SOS with Service VM
- Replace User OS with User VM
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-28 13:32:11 -07:00
David B. Kinder
abb564ba41 doc: add top-level redirect
* Add a script for creating top-level redirects on the
  projectacrn.github.io site.
* Use it to generate the top-level index.html redirect to
  latest/index.html in the Makefile (for make publsh).
* Generate a new redirect for hardware.html to catch inbound links.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-28 13:22:14 -07:00
David B. Kinder
e790b5cc6e doc: switch to use google tag manager
Use the GTM tag ID instead of UA.  Clean up stray inclusion of
analytics.js code.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-27 15:17:49 -07:00
Amy Reyes
a3ec34b3d6 Update Step 2 per feedback
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-21 11:42:29 -07:00
Amy Reyes
4706f451eb Update per comments 2021-10-21 11:42:29 -07:00
Amy Reyes
c2b10d5dcd Update per comments
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-21 11:42:29 -07:00
Amy Reyes
36fc1024e7 Fix line widths
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-21 11:42:29 -07:00
Amy Reyes
fc0112067e doc: update Overview with DX recommendations
- Capitalize Board Inspector and ACRN Configurator names to highlight them in images and content
- Remove duplicate links between the Overview and GSG where not needed
- Provide additional details that help to deepen developer’s knowledge where applicable.  Potential items: acrn-dm, more clarity of the relationship between the ServiceVM and UserVMs, expanded definitions of scenarios (beyond one liners).

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-21 11:42:29 -07:00
Amy Reyes
ca32ae7e3d doc: terminology cleanup in hv-dev-passthrough.rst
- Change UOS and SOS to User VM and Service VM, respectively
- Change guest to VM or similar depending on context
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-20 11:00:40 -07:00
David B. Kinder
e0bb4c800d doc: tweak python requirements for doc building
Add compatible version ranges for breathe and sphinx to appease check by
show-versions.py

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-19 18:20:36 -07:00
David B. Kinder
e2e33f76b9 doc: update to sphinx_rtd_theme 1.0
The sphinx_rtd_theme 1.0 includes simplified configuration for Google
analytics, along with general fixes and improvements.

Anyone publishing project documentation to projectacrn.github.io must be
using this updated sphinx_rtd_theme for Google Analytics data to be
properly collected.

* Switch to use this new theme version, and clean up the previous method
  of collecting analytics data.
* Update requirements.txt to use this new theme version. Update the
  show-versions.py script (used to report on installed doc building tools)
  to also report if there's a mismatch on which version is expected (in
  requirements.txt) and what's currently installed.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-19 13:04:01 -07:00
David B. Kinder
3bbab125b1 doc: prepare docs for removal of HV_RAM_SIZE option
HV_RAM_SIZE will be eliminated as a configuration option so we'll need
to remove references to it in the documentation.

See PR #6664 and PR #6681

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-19 07:14:05 -07:00
Amy Reyes
ef1b10349b doc: Delete old files from getting-started folder
- Delete Photoshop (.psd) files that are outdated and no longer needed

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-14 07:58:47 -07:00
David B. Kinder
82853a53e1 doc: more scenario name fixes
Update logical partition to simply partitioned.

Remaining references to logical partition are because the documentation
is validated for releases prior to the scenario renaming.  When those
are updated to be tested with a newer release, we'll update the
documentation accordingly.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-14 07:54:30 -07:00
Liu Hang1
7c2c3ad636 doc: add acrn-dm parameter emul explanation
add the emul list table to acrn-dm paramter
chapter

Tracked-On: #5406

Signed-off-by: Liu Hang1 <hang1.liu@intel.com>
2021-10-13 15:24:17 -07:00