- Update overview, dependencies and constraints
- Update to match Configurator UI instead of manually editing XML files
- Remove architectural details and instead point to high-level design documentation
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
below parameters are obsolete, reserve the code for potential use
but remove the description in document.
amd_hostbridge
virtio-ipu
virtio-hyper_dmabuf
virtio-audio
Tracked-On: #6690
Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
Add launch script document so that customers could understand how an
User VM is launched by ACRN Device Model.
As launch script is a user friendly tool to set Device Model parameters,
append the contents to Device Model Parameters chapter.
Tracked-On: #7801
Signed-off-by: Qiang Zhang <qiang4.zhang@linux.intel.com>
- Update overview, dependencies and constraints
- Update to match Configurator UI instead of manually editing XML files
- Remove architectural details and instead point to high-level design documentation
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
- Regarding post-launched VMs, update the messaging about static vs. dynamic. Dynamic is more about creating a VM at runtime per PR 7802, not changing the configuration of an existing VM at runtime.
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
Add v3.0 support for TGL Vecow system, starting at the maintenance level
of support. Transition NUC11TNHi5 from maintenance to community level
support for v3.0. Maintain all other boards at community level support.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
- Add Configurator Debian package build steps that were removed from GSG
- Add description of error icon on parameters tabs
- Mention that working folder name should be meaningful
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
systemctl won't run as a normal Linux user, requires sudo
Also augment the description information
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
- Update Configurator UI steps
- Emphasize connecting USB devices
- Use release_3.0 branch until tag is created
- Fix typos
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
"systemd-networkd" is required for acrn-dm to create bridge device.
Document it in GSG before acrn network deb package is ready.
Tracked-On: #7738
Signed-off-by: Qiang Zhang <qiang4.zhang@intel.com>
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>
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>
Add a configuration parameter for the xsltproc processing to decide
whether to include hidden options.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Removing Launch Configuation Options doc because all the launch script options are part of the new combined scenario XML and covered in Scenario Configuration Options doc.
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
The "make pdf" processing doesn't handle .svg files that were introduced
for the config option documentation. Change these images to .png
instead.
The "make pdf" processing tools produce slightly different log output.
Tweak the "known issue" processing script (that removes messages from
the sphinx_build output for known issues that we can safely ignore.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Fix how the config option doc scripts behave when encountering elements
with blank titles (used to remove extraneous headings in the
configurator UI).
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The acrn:views processing for showing which tabs an option would display
on wasn't quite right when an element AND a parent both had a views
attribute (specifically when the parent had "basic, advanced" but the
element only had "basic" or "advanced").
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Edit the schema (.xsd) files to modify the order options are presented.
None of these changes invalidate existing scenario XML files, as they
only reorder elements within the existing parent element, or tweak the
acrn:views, acrn:title, or documentation content.
Move simple type elements before complex type options (under the same
parent element) to avoid the confusion where options look like they're
part of a section based on the title that's added before complex typed
options but not simple typed options.
* add acrn:title to pcpu (pCPU list)
* change documentation for binary option saying "checked" instead of 'y'
* move HYPERV_ENABLED before RDT (simple type before complex type)
* move vuart_connections before FEATURES
* move name before vm_type
* move console_vuart, os_type, vuart0, vbootloader, usb_xhci before
lapic_passthrough
* add acrn:title to epc_section
* add acrn:title to memory
* move gpu to top of virtio_devices (simple type before completx type)
Tracked-On: #5692
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The configurator today shows "Please Input" as the placeholder of input
widgets, which is far from informative.
This patch specifies element or type specific placeholders in the XML
schema by reusing the `acrn:widget-options` annotation mechanism. For
manually-designed widgets such as ivshmem or vUART the placeholders are
added in the corresponding vue directly.
Tracked-On: #6691
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
remove configurator in misc/config_tools/config_app, since
there is new configurator in misc/config_tools/configurator.
remove related document.
Tracked-On: #7466
Signed-off-by: hangliu1 <hang1.liu@linux.intel.com>
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>
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>
Reduce expression complexity when searching for applicable-vms and views
annotations and increase ancestor search distance.
Don't sort glossary options to more closely mimic order found in the
configurator.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
When an element in the schema does not have an acrn:applicable-vms or
acrn:views (as opposed to having the attribute with an empty value,
acrn:views="") we need to look up the ancestors to see if any of them
have an element with such an attribute defined. If non of the ancestors
have that attribute defined, then the intrepretation is that the element
can be found for all VMs or for both basic and advanced tabs.
Tweak the xslt processing of the schema data to option config doc to
reflect these semantics.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Change the generated config option documentation to use the DX-friendly
names defined for the configurator UI (instead of the XML element name
hierarchy previously used).
Options are grouped by the top-level section (aka complex type) they
belong to and then sorted alphabetically with these groups.
Use badges to indicate where options can be found in the configurator UI
and whether they're applicable to the Hypervisor or Pre/Post/Service VM.
Add a custom css style for the config-option doc that puts the first
paragraph of a glossary item on the same line as the glossary term so
these badges look pretty.
Added a acrn-custom.js patch that copies the alt text for images into a
title property for images within the config-doc document. This provides
tooltip text when hovering over the badges.
Don't display options not visible in the configurator UI (elements with
acrn:views="").
A missing acrn:views or acrn:applicable-vm means we look for an
applicable value from an ancestor element.
Add processing of a second xs:documentation element within an
xs:annotation element. This second documentation element's content will
be appended as a new paragraph to the first xs:documentation content in
the generated documentation. Only the first xs:documentation element is
used by the Configurator for its tooltips.
Update documents that were referring to options by their XML names.
Because we're now using a glossary to provide links to config options,
we can't duplicate option names or glosary names anywhere in the doc
set.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The read-the-docs theme uses a reduced font size within tables. The CSS
used though is overly restrictive and doesn't properly handle tables
containing lists or other constructs where the paragraph tags don't have
the <td> tag within the table as the immediate parent. Add an
overriding style in our custom CSS to fix this so the font size on lists
within a table are the same as normal paragraphs within a table.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>