Commit Graph

251 Commits

Author SHA1 Message Date
wenlingz
22dbb6baed modify elementpath version =2.5.0
Modify elementpatch version and update doc part

Tracked-On:projectacrn#6688
Signed-off-by: wenlingz <wenling.zhang@intel.com>
2022-07-19 10:21:33 +08:00
Kunhui-Li
506c87cfa3 doc: update GSG picture
update GSG picture.

Signed-off-by: Kunhui-Li <kunhuix.li@intel.com>
2022-06-29 22:27:07 -07:00
David B. Kinder
5a2695d1d1 doc: fix gsg instructions for building the acrn-kernel
You need to be in the acrn-kernel directory in order to ``run make
distclean`` Also remove mention of 6 vms...

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 22:11:38 -07:00
David B. Kinder
e1e2ed898b doc: update release_3.0 with changes from master
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 16:54:09 -07:00
David B. Kinder
4bfbab8d89 doc: update draft 3.0 published docs to include changes on master
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-16 21:09:41 -07:00
David B. Kinder
8234871d45 doc: update release_3.0 docs for draft publishing
For testing the daily configurator's references to published
documentation (for more details) we need a draft of the 3.0 docs
published.  Here are all the available updates from the master branch
applied to the release_3.0 branch. We'll update these again for the
final 3.0 doc release.

Tracked-On: #5692

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-10 11:44:57 -07:00
Yuanyuan Zhao
5836a1bb03 config_tools: merge python packages list for configurator
Merge python packages list into one 'requirements.txt'.
And modify related document.

Tracked-On: #7508
Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-06-01 16:51:52 +08:00
Yuanyuan Zhao
6fb5f2b8f5 doc: GSG's python dependence
For config_tools use python to clear dirty files, add python dependence
while prepare development computer.

Tracked-On: #7508
Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-06-01 16:51:52 +08:00
Reyes, Amy
f4b217b059 doc: remove unused images from get-started folder
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-12 11:41:58 -07:00
Shiqing Gao
f8de4178e4 doc: update GSG for virtio-gpu dependency libraries
commit 78f702e ("Use libdrm library for drm access") adds the dependency on
libdrm library. GSG needs to be updated accordingly. Otherwise, compilation
error occurs like below:
hw/pci/virtio/virtio_gpu.c:21:10: fatal error: libdrm/drm_fourcc.h: No such file or directory
   21 | #include <libdrm/drm_fourcc.h>
      |          ^~~~~~~~~~~~~~~~~~~~~
compilation terminated.

Tracked-On: #7464

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2022-05-11 22:00:49 -07:00
Reyes, Amy
c16ee09727 doc: Remove acrn quick setup script
- This script is outdated. The last time it was used was v2.0.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-06 16:08:08 -07:00
Reyes, Amy
049a01c638 doc: Remove outdated ClearLinux Docker file
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-06 16:07:01 -07:00
Chenli Wei
288c6853f4 doc: fix the make configurator fails issue
The current code need python3.8-venv to build some modules, so we
should add these requirement to "Getting Started Guide".

This patch modify the getting-started.rst to generate new guide.

Signed-off-by: Chenli Wei <chenli.wei@intel.com>
2022-05-06 11:41:47 -07:00
David B. Kinder
e491773f5e doc: remove obsolete (and orphaned) docs
We removed some documentation from the table of contents but left them
around in the published documentation.  All of these documents are
obsolete and haven't been updated since they were last validated on
earlier versions of ACRN.  (They all can still be referenced in the
older version archives if needed.)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-05-03 15:16:46 -07:00
Reyes, Amy
ca3251a47d doc: Update Configurator steps
- Add build steps
- Update steps per new UI

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-05-03 15:16:21 -07:00
Reyes, Amy
d881276fee doc: Add note to GSG about optional upgrade
- Add comment in upgrade command in case users ignore description above command

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-04-18 17:18:14 -07:00
Sun Peng
e8934aeb41 doc: virtio-gpu dependency libraries
Add virtio-gpu dependency libararies in getting-started documents.

Tracked-On: #7210
Reviewed-by: Zhao Yakui <yakui.zhao@intel.com>
Signed-off-by: Sun Peng <peng.p.sun@linux.intel.com>
2022-03-28 15:26:20 +08:00
Reyes, Amy
04eefc9516 doc: Add poweroff step to gsg
- Add an optional step in GSG to power off User VM.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-03-21 17:21:36 -07:00
Reyes, Amy
4eb14e7a0d doc: Update Getting Started Guide
- Update to Ubuntu 20.04
- Add Debian pkg usage.
- Modify mem parameter in launch xml to 1024M.

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-03-16 18:16:17 -07:00
jackwhich
5c5fbd6a5b doc: revert gsg libcjson dependency
Add gsg to install libcjson-dev dependency notes

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2022-03-09 13:53:37 -08:00
David B. Kinder
0283202193 doc: fix docs with missing newline at EOF
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-02-28 12:16:18 -08:00
jackwhich
bd02de15b0 doc: Remove modprobe msr in gsg
modprobe msr has been added to board_parse.py in PR #6692.

Remove modprobe msr in gsg and board_inspector docs

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
2022-02-22 09:45:29 -08:00
Xiangyang Wu
53dd2954d2 doc: add libcjson-dev installation in GSG
Libcjson package is needed to build command monitor of DM,
so this should be installed in the user's development machine.

Tracked-On: #5921

Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
2022-02-18 18:33:52 +08:00
Reyes, Amy
e09968e5e4 doc: Update Debian packaging readme
- Update doc for v2.8 release

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-10 12:43:59 -08:00
Geoffroy Van Cutsem
21d7b242c9 doc: update the method to run the acrn_configurator.py
Update the instructions on how to start the ACRN Configurator tool
('acrn_configurator.py'). It is no longer require to use 'python3 ...'
since we've added a shebang header to the file and made it executable.

Tracked-On: #7057
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2022-01-26 14:20:43 +08:00
Yuanyuan Zhao
75884af9ac doc: remove dm dynamic param '-A'
Update document to remove 'acrn-dm' dynamic param '-A'.

Signed-off-by: Yuanyuan Zhao <yuanyuan.zhao@linux.intel.com>
2022-01-21 16:07:37 -08:00
Reyes, Amy
a62e468aab doc: Update images
- Update images to align better with ACRN branding

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-01-21 16:04:45 -08:00
jackwhich
ad5cf0ea3e doc: update GSG and partitioned documentation
1. Update launch script and replace the apt-get command with apt in GSG documentation.
2. Update the tag to v2.7 in partitioned documentation.

Signed-off-by: zhongzhenx.liu <zhongzhenx.liu@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-15 13:37:42 -08:00
David B. Kinder
7c8004ab0d doc: fix $disk usage in GSG
The commands in the Getting Started Guide for copying files to and from
the USB stick will fail if the USB stick volume name has a space in it.
Fix this by quoting uses of $disk.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-12-14 10:42:42 -08:00
Amy Reyes
4ea23b1292 doc: terminology cleanup in GSG
- Replace SOS or Service OS with Service VM
- Replace UOS or User OS with User VM
- Capitalize ACRN Configurator and Board Inspector
- Clean up some of the grammar

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-11-29 16:44:07 -08:00
Xiangyang Wu
1d26695626 doc: refine enable s5 document
Lifecycle Manager will be refined in v2.7, this patch will
refine enable s5 document to align with the latest code.

v1-->v2:
	Remove the prompt from all instructions in this
	document.

Tracked-On: #6652

Signed-off-by: Xiangyang Wu <xiangyang.wu@intel.com>
2021-11-19 07:07:32 -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
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
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
Amy Reyes
ae5fc5e494 doc: Update config tool doc and gsg per UI changes
- Update text and screenshots per UI changes in PR 6549

Signed-off-by: Amy Reyes <amy.reyes@intel.com>
2021-10-13 11:31:45 -07:00
David B. Kinder
0c677fd3b4 doc: remove unreferenced images
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-11 18:20:12 -07:00
David B. Kinder
7bcfd58f05 doc: update GSG with DX recommendations
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-11 11:51:45 -07:00
David B. Kinder
5e0e6b434c doc: fix cumulative issues in GSG from DX study
Address a collection of small issues in the GSG:
- remove mention of the (optional) serial port use
- update recommended development computer memory size
- mention why there are six user VM launch scripts (and that we're only going to
  use one of them)
- clarify how OS installed for running board inspector is modified with
  the Linux kernel built using board and configuration information
- add commands used to confirm files are in the expected directories
- remove specific BIOS example (keep just settings info)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-11 09:37:06 -07:00
David B. Kinder
e03f0045dc doc: update docs and images to match scenario names
Update the docs and images referencing ``industry`` and ``logical_partition`` scenarios to
``shared`` and ``partioned``.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-10-04 15:53:45 -07:00
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
David B. Kinder
d8e0b7df43 doc: update redirects for deleted docs
Add a couple of redirect pages for 404 errors noted in analytics data,
and add replace the deleted roscube GSG with a doc linking to the last
updated version in v2.5.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-28 11:52: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
824d4a21cb doc: remove unreferenced images
Over time, and after deleting or moving documents around, we've left
behind quite the collection of unreferenced images.  It's time to clean
them out of the doc folders.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-09-22 16:29:57 -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