Commit Graph

49 Commits

Author SHA1 Message Date
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
Xie Zhengtian 4b2e7f1123 Delete AGL about 2018-12-03 20:48:10 -08:00
Xie Zhengtian be70145f4c Delete AGL about 2018-12-03 20:48:10 -08:00
Xie Zhengtian 96a2946d72 Delete AGL about 2018-12-03 20:48:10 -08:00
Xie Zhengtian 6c8c46af8f delete AGL about 2018-12-03 20:48:10 -08:00
Xie Zhengtian ce89d26e76 Delete using_AGL_as_uos.rst 2018-12-03 20:48:10 -08:00
Xie Zhengtian 3d96e35643 Rename using_AGL_as_uos to using_AGL_as_uos.rst 2018-12-03 20:48:10 -08:00
Xie Zhengtian 90c27157e4 Create using AGL as UOS 2018-12-03 20:48:10 -08:00
Xie Zhengtian 2bc24f8789 Upload the images for "using_AGL_as_uos" 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
Tonny Tzeng 6d6c5b959c [doc] Enhance Using partition mode on UP2 tutorial 2018-11-28 12:13:37 -08:00
Geoffroy Van Cutsem 469496311c Documentation: add 'make' to GSG and expand PATH for `sphinx-build`
Getting Started Guide: add one more bundle to be added on a Clear
Linux development machine to make sure 'make' and other development
packages are available.

ACRN Documentation Generation: expand the 'PATH' variable to include
'~/.local/bin' where 'sphinx-build' is installed.

Tracked-On: #1650

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-11-02 16:45:58 -07:00
Geoffroy Van Cutsem d6523964ee Documentation: tweak 'partition mode' tutorial
Tweak the 'Using partition mode on UP2' tutorial by removing
a couple of Grub menu entries that are not present by default
(nor introduced as part of the tutorial).

Also make it more obvious that there is still a default entry
called 'Ubuntu' which is the one by default.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-10-26 15:06:20 -07:00
David B. Kinder d764edbf83 doc: update GRUB menu image in partition mode doc
Replace the askew photo of a GRUB screen with a ``code-block:: console``
directive.

Tracked-On: #1160

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-25 10:43:20 -07:00
Kaige Fu 61a9ca2053 Documentation: Add tutorial about how to use partition mode on UP2
This patch adds tutorial about all the steps you need to take in order to use
partition mode with ACRN hypervisor on UP2.

Tracked-On: #1160
Signed-off-by: Kaige Fu <kaige.fu@intel.com>
2018-10-25 10:14:36 -07: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 68ce114b43 doc: add tool for verifying installed doc tools
Added a python script that displays versions of doc building tools
(e.g., doxygen, breathe, sphinx) to help verify doc building environment
is properly set up (can help doc building problem diagnostic, as shown
in issue #1333

Update doc build documentation to reference this script.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-26 13:34:25 -07:00
David B. Kinder 23cf8079e7 doc: update tagged release doc build instructions
Update the doc build instructions to include how to update the version
navigation selector (bottom of the left nav panel), and make commands
for building and publishing specific tagged releases (e.g., 0.2)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-24 13:43:03 -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 3abfdbab72 doc: add script for syncing acrn-kernel for API gen
API doc generation includes kernel components provided by ACRN that live
in the acrn-kernel repo (not the acrn-hypervisor repo). We need to
include fetching the latest acrn-kernel sources when we do doc
generation, and update the documentation to mention we now need the
acrn-kernel repo as a sibling folder for the acrn-hypervisor repo
contents.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-24 17:20:43 -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
David B. Kinder 05d2558f9f doc: move graphviz material to developer-guides
Rather than a "tutorial", it was suggested to move the graphviz
information to the devleoper-guides, along with the documentation
guidelines.  Makes sense.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-03 09:48:19 -07:00
Miguel Bernal Marin 5d94e9bbf0 Documentation: fix set up a static IP tutorial
Clear Linux is a stateless system, also systemd.

https://clearlinux.org/features/stateless

This tutorial advice to modify a file in /usr/lib which is used by vendors.
Instead of that, this commit advice to use the local administration
network directory at /etc/systemd/network.

See more reference using:

man systemd.network

Fixes: 25eae47836 ("Documentation: add tutorial to set up a static IP address")
Signed-off-by: Miguel Bernal Marin <miguel.bernal.marin@linux.intel.com>
2018-07-03 09:47:23 -07:00
Geoffroy Van Cutsem 25eae47836 Documentation: add tutorial to set up a static IP address
Add a tutorial on how to change the default configuration that
uses DHCP and assign a static IP address to the system.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-06-29 10:48:36 -07:00
David B. Kinder 3965593df6 doc: reorganize documentation
We've been expanding documentation, and now need to organize things a bit
cleaner and separate content into new major folders: Introduction, Getting
Started, User Guides, Developer Guides, Tutorials, and Release notes..

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-06-28 22:36:13 -07:00