Commit Graph

20 Commits

Author SHA1 Message Date
David B. Kinder
ea4328f5f4 doc: GSG apt install command DX improvement
As recommended, add a ``-y`` to the ``apt install`` commands so they
don't prompt the user to confirm the installation, seen as unnecessary
in this context.

Also, wrap lines that are longer then 80 chars to improve git reviews
and follow our doc conventions.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-30 11:08:48 -07:00
Amy Reyes
0ac609b5d8 doc: create ACRN config tool/board inspector docs
- Create ACRN config tool doc based on info in existing "Intro to ACRN Configuration" doc, add clarifications
- Create board inspector tool doc based on info in existing "Intro to ACRN Configuration" doc, add clarifications
- Create launch config options doc based on info in existing "Intro to ACRN Configuration" doc, similar to existing scenario config options doc
- Update refs that no longer exist
- Create hypervisor makefile options doc, combining makefile info from "Intro to ACRN Configuration" doc and "Build ACRN from Source" doc
- Clarify why you need config files, difference between scenario vs. launch VM settings
- Updates are intended to reflect v2.6 code

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-09-28 08:59:08 -07:00
David B. Kinder
60baaea3cd doc: update checkout branch in GSG
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-27 19:11:31 -07:00
David B. Kinder
bd57475854 doc: add iomem kernel parameter for board inspector
Without this ``iomem=relaxed`` kernel parameter, the generated board XML
is essentially the same as having ``--basic`` when executing the board
inspector, i.e. the ACPI namespace will not be parsed. The generated
board XML may still work, but some functionality (e.g. passthru of TPM
and other PCI devices that need INTx) will no longer work due to lack of
hardware information.

Replacing PR #6618

Tracked-On: #5692

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-24 11:40:24 -07:00
David B. Kinder
0d03224070 doc: fix mispellings and formatting
* General scan for misspellings, "smart quotes", and formatting errors
  missed during regular review. Also removed used of "please".

* Fix old XML examples that had desc="..." comments. These comments were
  moved to to xsd files instead of being in the XML files themselves.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-21 10:46:12 -07:00
jackwhich
4f2e3384b1 Add sample diagrams for user reference. 2021-09-20 08:22:58 -07:00
jackwhich
321653e3c7 doc: update documentation and grub file
1. Because the < > in the document will mislead users to copy and paste directly,
       modify the < > to " ".
       Add sample diagrams for user reference.
    2. Because there is a problem with the user adding the GRUB_CMDLINE_LINUX=text
       parameter, delete this parameter.
    3. The script generation of launch_uos_id3.sh does not match the GitHub and doc,
       modify the parameters.

    Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2021-09-20 08:22:58 -07:00
David B. Kinder
1f1ca8f253 doc: tweak GSG DX issues
Fix some issues found during DX studies of the new GSG that are trivial
changes but are impacting users in the study.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-08 12:51:49 -07:00
amyreye
904f9e11b2 doc: use "ACRN configurator" name in Overview, GSG
Replaced "ACRN configuration editor" name with "ACRN configurator" in text and image to match the recently renamed acrn_configurator.py.

Note:

* The gsg_overview_image_sources.pptx file is the editable source file for overview_flow.png.

* I changed the name "configuration editor" to "ACRN configurator" in gsg_overview_image_sources.pptx and then saved as overview_flow.png.

* Although GitHub will say that I added gsg_overview_image_sources.pptx, this file already exists in master. I just edited it.

* GitHub may say that I removed overview_flow.png. In the PR, try clicking "Display the rich diff" icon. It will show that the existing image was replaced with the edited image.

Signed-off-by: amyreye <amy.reyes@intel.com>
2021-08-30 09:33:22 -07:00
Musa Ünal
da01f679b4 Add bc to build dependencies 2021-08-24 14:22:55 -07:00
David B. Kinder
8894081379 doc: update GSG checkout commits
Need to "freeze" the acrn-hypervisor for DX reviews since the
release_2.6 branch is still changing with fixes.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-23 18:56:27 -07:00
amyreye
5a8b9ff8f2 Fix step numbers 2021-08-23 16:23:03 -07:00
David B. Kinder
530baaafc6 doc: more GSG DX tweaks
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-23 14:04:55 -07:00
David B. Kinder
ce84751274 doc: additional DX edits to the new GSG
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-23 11:01:57 -07:00
David B. Kinder
bbe76d6b2a doc: GSG tweaks for DX
- mention usefulness of a fast computer for improving build time
- move Ubuntu boot USB drive earlier in the list of prereqs
- move some sentences around for clarity
- improve appearance with some more spacing after images

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-08-22 21:43:21 -07:00
David B. Kinder
50094fb88b doc: DX update for GSG
- Update the Getting Started material with a DX-inspired rewrite and
  simplification.
- Remove duplicate and out-of-date "Building from Source"
  document, deferring to the new GSG.
- Add a development overview document.
- Move other GSGs to the advanced guides section.
- Update links in other documents to aim at the new GSG.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-08-20 07:53:18 -07:00
Yang,Yu-chu
668ae81048 config-tools: replace xml.etree.ElementTree with defusedxml.ElementTree
Using xml.etree.ElementTree to parse the untrusted data is known to
raise security issue. Replaced it using defusedxml.

Tracked-On: #6342
Signed-off-by: Yang,Yu-chu <yu-chu.yang@intel.com>
2021-08-13 16:11:42 +08:00
Kunhui-Li
25c677dc39 doc: fix documentation's issue
1. Update the necessary libraries to consistent with the "Build ACRN From Source"
document in the "Getting Started Guide" document.
2. Delete the related introduction with acrngt.conf and launch_uos_id1.sh files in
"Getting Started Guide" document.
3. Update WHL-IPC-I7 board's processor in Supported HW document.
4. Add cpu_affinity element's description in ACRN Configuration Data.
5. Update the description for shm_region in Launch XML format.
6. Update configurable/readonly attributes values.
7. Update the description for hv.CAPACITIES.MAX_MSIX_TABLE_NUM in schema/config.xsd.

Tracked-On: #5692
Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2021-06-23 19:25:22 -07:00
David B. Kinder
f3dd19dea7 doc: fix renaming of getting started guide
Tweak references to account for renaming the getting started guide in
PR #6226 and create a redirect link from the previous filename.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-06-21 13:48:34 -07:00
Geoffroy Van Cutsem
6b6efed7eb doc: updates to the Getting Started Guide
Updates to the Getting Started Guide:
* Update title to simply be "Getting Started Guide"
* Simplify and remove instructions that are redundant
* Add a note explaining the difference between 'nuc11tnbi5' and
  'nuc11tnhi5'

Tracked-On: #6225
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-06-21 11:24:12 -07:00