Commit Graph

19 Commits

Author SHA1 Message Date
Reyes, Amy 8b21a85e1f doc: Remove FAQ from TOC
Per issue #5265, removing the FAQ from the table of contents until we create more content

Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-02-16 15:37:00 -08: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
Shuang Zheng b953a33bd8 config_tools: remove UOS_RAM_SIZE and SOS_RAM_SIZE in scenario config
remove UOS_RAM_SIZE and SOS_RAM_SIZE in scenario config since these
two config elements are useless.

Tracked-On: #5927
Signed-off-by: Shuang Zheng <shuang.zheng@intel.com>
Reviewed-by: Victor Sun <victor.sun@intel.com>
2021-04-19 14:45:10 +08:00
Geoffroy Van Cutsem 31a9d053f8 doc: update our FAQ section
Update our FAQ section by deleting outdated and obsolete information.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2021-02-23 11:51:42 -08:00
David B. Kinder 0bd384d41b doc: fix all headings to use title case
While we hoped to make the headings consistent over time while doing
other edits, we should instead just make the squirrels happy and do them
all at once or they'll likely never be made consistent.

A python script was used to find the headings, and then a call to
https://pypi.org/project/titlecase to transform the title.  A visual
inspection was used to tweak a few unexpected resulting titles.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-02-13 12:37:49 -08:00
David B. Kinder c741468b9c doc: remove Kconfig reference documentation
With the new ACRN configuration architecture, we no longer use Kconfig
files.  Remove the Kconfig option documentation scripting (genrest.py)
Python dependencies, and Makefile commands, and change references in the
documentation from the Kconfig option (such as
:option:`CONFIG_MEM_LOGLEVEL`) to the new schema definition-based option
documentation (:option:`hv.DEBUG_OPTION.MEM_LOGLEVEL`).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2021-02-03 09:01:40 -08:00
David B. Kinder dd0fe54141 doc: Spelling and grammar tweaks
Did a partial run of ACRN documents through Acrolinx to catch additional
spelling and grammar fixes missed during regular reviews.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-09-26 08:50:49 -07:00
David B. Kinder 066744ce5d doc: update FAQ
Remove obsolete information and Clear Linux/UEFI references.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-25 17:50:37 -07:00
David B. Kinder db454dcdf1 doc: rst syntax tweaks
There are some subtle syntax errors in some documents that, while they
render OK (most of the time), are being caught by rstcheck (a
restructuredText linter). This PR fixes most of the issues encountered.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-06-03 14:37:37 -07:00
David B. Kinder 4b1dfe9632 doc: remove trailing spaces
Remove trailing spaces on lines to avoid potential issues with git

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-04-15 11:46:06 -07:00
lirui34 ec6777ab09 doc: Update 1.4 versions and some words
Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-21 10:15:46 -05:00
lirui34 958ea0f11b doc: Stop using kconfig to make a customized efi.
Also fix some quick setup script issues.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-08 08:28:46 -08:00
lirui34 f835fdef05 doc: Remove apl gsg and merge contents into rt gsg
Change APL getting started guide to KBL getting started guide;
Merge some of the contents into preempt-rt getting started guide;
Move the modified kbl getting started guide to the behind of the configuration tutorials;
Fix issues for acrn_quick_setup.sh script.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-05 15:09:49 -05:00
zhangyun 7553d1cd26 doc: How to build ACRN on Fedora 29
Update FAQ about compilation issue workaround on Fedora 29

Tracked-On: #2457
Signed-off-by: zhangyun <yunxzhang@intel.com>
2019-04-30 10:23:19 -07:00
Geoffroy Van Cutsem 904c9e291e doc: add more details to the FAQ (for version 0.7)
Add more details and clarifications to the new FAQ being added for v0.7

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-03-22 10:01:34 -04:00
wenlingz c47efa3f5a Add new FAQ
Signed-off-by: wenlingz <wenling.zhang@intel.com>
2019-03-22 10:01:34 -04:00
Victor Sun a01c3cb913 doc: change term of vm0 to sos_vm
Using term of VM0 would mislead to a VM with VM id 0 easily, whereas
VM id 0 could be used for any PRE_LAUNCHED_VM. So replace VM0 with
SOS_VM.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2019-01-30 17:14:26 -08:00
David B. Kinder 0881bae738 doc: fix correct use of Clear Linux OS
Proper use of the Clear Linux name is with a noun, specifically "OS".
Also fixed some grammar edits along the way.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-30 15:17:33 -08:00
David B. Kinder c43bca9c86 doc: add a FAQ doc
Start a new FAQ document with questions we're often being asked on
support channels.  We'll expand this list over time, and as the number
of questions grow, we'll organize them as appropriate.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-23 22:29:56 -08:00