Commit Graph

43 Commits

Author SHA1 Message Date
Deb Taylor
c3582dcd04 Doc: Edits to workaround note for EFI command line option string issue.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-24 21:11:52 -04:00
fuzhongl
4ea3676f26 Doc: add space at the end of efibootmgr bootloader
This is a workaround for the issue in efi-stub: If the EFI option is loaded to a memory range which is not all zero filled,
it's possible the garbage string appended to bootloader name string.
Which could make system can't boot.

Add an extra space to the EFI option to make sure space could be used to detect the end of bootloader name string.

Once the fixing patch is merged, we don't need this extra space.
But to make old ACRN work, we'd like to keep the space here.

Signed-off-by: fuzhongl <fuzhong.liu@intel.com>
Reviewed-by: Yin Fengwei <fengwei.yin@intel.com>
2020-03-24 19:34:44 -04:00
David B. Kinder
a086d72974 doc: fix docs with broken links
Fix links in documentation that have moved (e.g.,
clearlinux.org/documentation moved to docs.01.org/clearlinux/latest).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-03-22 11:35:17 -04:00
Deb Taylor
7d4b2c824f Edits to Ubuntu SOS; changed SOS/UOS to Service VM/User VM
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-02-11 16:47:55 -05:00
Geoffroy Van Cutsem
db6fe1e347 doc: update Grub configuration instructions for Ubuntu (Service VM)
Update the "Using Ubuntu as the Service OS" tutorial to tweak the instructions
pertaining to the Grub bootloader configuration. Specifically, update to reflect
the content of '/etc/default/grub' in Ubuntu 18.04 and also make loading the
Service OS kernel the default.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2020-02-10 09:46:00 -05:00
hongliang
9af4a62482 doc: edit using_ubuntu_as_sos.rst adjust to v1.4
Signed-off-by: hongliang <hongliangx.ye@intel.com>
2019-11-26 17:19:50 -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
Deb Taylor
6045a5e54c Intitial doc for Running Debian as a Service VM
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-12 22:07:09 -04:00
Geoffroy Van Cutsem
435b29af5f doc: update documentation to the latest TAP name (no acrn_ prefix)
Update the documentation, and associated scripts to reflect the fact
that the TAP device used by 'acrn-dm' no longer use the "acrn_" prefix.

Tracked-On: #2509
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-04-09 11:21:00 -07:00
Tw
46e7fa8cf2 doc: minor changes according to one binary for SBL and UEFI
PLATFORM=xxx is no longer supported, use BOARD instead.

Tracked-On: #2708
Signed-off-by: Tw <wei.tan@intel.com>
2019-04-01 14:39:52 -07:00
David B. Kinder
e9335fcee6 doc: fix utf-8 punctuation, branding, spelling
Fix some stray UTF-8 punctuation and symbol characters, unnecessary
trademark symbols, and some misspellings missed during regular reviews.

Tracked-On: #2712

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-14 09:13:58 -07:00
Geoffroy Van Cutsem
2638518349 acrn.conf: clean-up SOS kernel options (EFI platforms)
- Remove some i915 options that are obsolete and irrelevant for the
Service OS kernel
- Update the various tutorials that also used these obsolete parameters

Tracked-On: #2518
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-02-20 13:21:11 +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
Geoffroy Van Cutsem
9c97f6bec5 Documentation: split the build instructions into its own guide
Split the build instructions, and the hypervisor configuration instructions
into its own separate document.

Tracked-On: #2154
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-12-21 10:01:13 -08:00
Xie Zhengtian
3b54dd2abd doc: add some "sudo" for code 2018-12-03 20:48:10 -08:00
Xie Zhengtian
945fdd8a4a doc: update the directory to "~/" 2018-12-03 20:48:10 -08:00
Xie Zhengtian
0ff74b1367 doc: delete "install build tool" about 2018-12-03 20:48:10 -08:00
Xie Zhengtian
1a959d0f54 doc: Update note for the directory of UOS image 2018-12-03 20:48:10 -08:00
Xie Zhengtian
e2e9a3e9b9 doc: Add the note for the directory of UOS image 2018-12-03 20:48:10 -08:00
Xie Zhengtian
1052242319 doc: add note for the directory of UOS image 2018-12-03 20:48:10 -08:00
Xie Zhengtian
099c605eda doc: Modify to "/boot/efi"
1. No more mount needed, use the directory "/boot/efi"
2. The kernel of UOS stored in "~/uos-kernel-build"
3. (Pending) the image of UOS stored in "~/" or "/root"
2018-12-03 20:48:10 -08:00
Xie Zhengtian
ceed310661 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
Xie Zhengtian
b1db77eb81 doc: Update the grub part and add code for NVMe 2018-12-03 20:48:10 -08:00
coneypo
12e66b989a Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
ecff0bf9e8 Update the layout of packages 2018-12-03 20:48:10 -08:00
coneypo
50f1783200 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
1afb0f13c4 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
06b2ab55e3 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
e4941b2225 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
65f21a77e2 Update the version of Ubuntu to 18.04 2018-12-03 20:48:10 -08:00
coneypo
abfa1c1644 update the length of * 2018-12-03 20:48:10 -08:00
coneypo
1664ba5fa7 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
f3527c638c Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
e4b616d5fd Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
ab005bc8a8 Update using_ubuntu_as_sos.rst 2018-12-03 20:48:10 -08:00
coneypo
2d685a13ee Update with Clear Linux 26440 2018-12-03 20:48:10 -08:00
Geoffroy Van Cutsem
30c2901546 Documentation: typo in Ubuntu tutorial and additional note
Fix one typo (in a command) in the tutorial entitled "Using
Ubuntu as the Service OS".

Add a note explaining that a script may have to be adjusted
based on the HW set-up (network interface name).

Tracked-On: #1502

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-10-18 14:56:47 -07:00
Geoffroy Van Cutsem
2b449680ff Documentation: minor update to the tutorial about Ubuntu as SOS
Minor update to the tutorial on how to use Ubuntu as the Service OS
with ACRN. Specifically, the instructions for making the Grub menu
visible at boot time now involved modify the /etc/default/grub file
and not the /boot/grub/grub.cfg as before.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-10-17 05:54:49 -07:00
David B. Kinder
d32ef9b1eb doc: fix doc misspellings
fix misspellings in .rst files missed during regular reviews

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-05 16:06:19 -07:00
ailin,yang
f4513f903d update to fix format issue of ReST
accept the feedback from David
align the content to meet the ReST
2018-08-16 09:02:15 -07:00
ailin,yang
5a6ee3f3b3 update doc -Using Ubuntu as the Service OS
1, update contents to align latest acrn and clear Linux release
2, change /etc/grub.d/40_custom file to specify 'insmod ext2', not 'insmod ext4' and github issue- https://github.com/projectacrn/acrn-hypervisor/issues/707
3, add tap device and network sharing enabling script as the example for ubuntu SOS
4, add several tips for new user to use ubuntu as the SOS

Signed-off-by: ailun258 ailin.yang@intel.com
2018-08-16 09:02:15 -07:00
David B. Kinder
e04255822a doc: update GSG for v0.1, add console code-block
Console screen shots are hard to maintain, so use the
.. code-block:: console directive to show terminal console-like display
(black background with white text)

Change existing .. code-block:: console uses to .. code-block: none

Replace screen-shot images in apl-nuc getting started guide with
text-based console display.

Update apl-nuc GSG content with v0.1 changes

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-16 13:51:28 -07:00
Geoffroy Van Cutsem
dc135bd501 Documentation: tutorial on how to use Ubuntu as the SOS
Add a tutorial explaining how to use Ubuntu as the Service OS
running on ACRN and providing all the device sharing services
(devicemodel) and tools to manage virtual machines.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Signed-off-by: Ailin Yang <ailin.yang@intel.com>
2018-07-09 18:11:43 +08:00