For the 3.0.1 hot-fix release, update release_3.0 branch with doc
changes relevent updates since v3.0 tag. This is primarily for the
doc/asa.rst and doc/release_notes/release_notes_3.0.1.rst files, but
there was also a cleanup of deleted image files, and some changes made
for copyright years.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
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>
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>
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>
(bringing fix on master over to release_3.0 branch)
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>
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>
Many of the license and Intel copyright headers include the "All rights
reserved" string. It is not relevant in the context of the BSD-3-Clause
license that the code is released under. This patch removes those strings
throughout the code (hypervisor, devicemodel and misc).
Tracked-On: #7254
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Update the last_updated extension to correctly handle when new docs are
added and aren't yet commited into git vs. when the list of git folders
isn't correct. Previous PR #7251 incorrectly handled these as the same.
Tracked-On: #7249
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Instead of trying to maintain the release notes for old releases in the
current release, reference them in a previous archive. This eliminates
the need to fix doc build errors by editing old release notes that
reference material that no longer exists in the newer release.
We use the intersphinx extension to support references to
Sphinx-generated content from other projects. In our case, we're
referencing the archived version of v2.7 documents that was the last
release to generate release notes for all previous releases. This import
is done in conf.py.
(Alternatively we could reference the release notes for a release in
that specific release's archive, but that means fetchind the intersphinx
inventory file (objects.inv) for every release, and seems like
overkill.)
This modification still allows putting multiple release notes in the
doc/release_notes folder and they'll show up in the release notes index
as they have in the past. Update the separate "archived" release notes
section manually as needed.
Also, adds a draft of the v3.0 release notes to verify the new release
notes index page layout.
Fixes: #7171
Tracked-On: #7171
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
If a new document is added, the CI system fails because the new document
hasn't been checked into the branch yet so the last_updated.py script
complains with an error. Change to use the last_published date in this
situation.
Tracked-On: #7249
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
We use a post-processor to scan the output log from Sphinx to remove
known errors and warnings before deciding if the Sphinx build was
successful. If an exception happened during the Sphinx build, (see
about the error would appear. Update the Makefile to not stop on errors
for the Sphinx build. The post-processor will stop the make by returning
an error code if it finds unexpected errors in the log.
Tracked-On: #7249
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
When I added a new document that wasn't checked into GitHub yet, the doc
build failed with an unhanded exception:
Extension error (last_updated):
(exception: time data '' does not match format '%Y-%m-%d')
Problem is the git query looking up the last commit date for a file
returns an empty string for the date if the file exists but it's not in
the git repo (yet). The subsequent call to strptime raises an exception if passed
an empty string. This patch handles the exception.
Tracked-On: #7249
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
