Skip to content

Commit 07309fd

Browse files
coneypodbkinder
authored andcommitted
doc: update some statements
1 parent 40f375b commit 07309fd

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

doc/tutorials/using_agl_as_uos.rst

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ Using AGL as the User OS
44
########################
55

66
This tutorial describes the steps to run Automotive Grade Linux (AGL)
7-
as the User OS on ACRN hypervisor and the problems we got at current stage.
8-
We hope the steps documented in this article could help us to reproduce the
9-
problem much easier and provide some information for further debugging.
10-
The regulatory model of APL NUC we used is `NUC6CAYH
7+
as the User OS on ACRN hypervisor and the existing issues we still have.
8+
We hope the steps documented in this article will help others reproduce the
9+
issues we're seeing, and provide information for further debugging.
10+
We're using an Apollo Lake-based NUC model `NUC6CAYH
1111
<https://www.intel.com/content/www/us/en/products/boards-kits/nuc/kits/nuc6cayh.html>`_
12-
and other platforms may work too.
12+
and other platforms may be used as well.
1313

1414
.. image:: images/The-overview-of-AGL-as-UOS.png
1515
:align: center
@@ -18,22 +18,22 @@ Introduction to AGL
1818
*******************
1919

2020
Automotive Grade Linux is a collaborative open source project that is
21-
bringing together automakers, suppliers and technology companies to
21+
bringing together automakers, suppliers, and technology companies to
2222
accelerate the development and adoption of a fully open software stack
2323
for the connected car. With Linux at its core, AGL is developing an open
2424
platform from the ground up that can serve as the de facto industry
2525
standard to enable rapid development of new features and technologies.
26-
For more information about AGL, please visit AGL’s official website:
27-
https://www.automotivelinux.org/.
26+
For more information about AGL, please visit `AGL’s official website
27+
<https://www.automotivelinux.org/>`_.
2828

2929
Steps for using AGL as the UOS
3030
******************************
3131

3232
#. Follow the instructions found in the :ref:`getting-started-apl-nuc` to
3333
boot "The ACRN Service OS"
3434

35-
#. In SOS, download the release of AGL from https://download.automotivelinux.org/AGL/release/eel/,
36-
and we will use ``eel_5.1.0`` release for example
35+
#. In SOS, download the release of AGL from https://download.automotivelinux.org/AGL/release/eel/.
36+
We're using release ``eel_5.1.0`` for our example:
3737

3838
.. code-block:: none
3939
@@ -67,7 +67,7 @@ Steps for using AGL as the UOS
6767
-B "root=/dev/vda2 ...
6868
6969
.. note::
70-
In case you have downloaded a different AGL image or store the image in other directory,
70+
In case you have downloaded a different AGL image or stored the image in another directory,
7171
you will need to modify the AGL file name or directory (the ``-s 3,virtio-blk`` argument)
7272
to match what you have downloaded above.
7373
Likewise, you may need to adjust the kernel file name to ``default-iot-lts2018``.
@@ -85,44 +85,43 @@ Steps for using AGL as the UOS
8585
.. image:: images/The-console-of-AGL.png
8686
:align: center
8787

88-
When you see the output of the console above, that means AGL has been loaded
89-
and now you could operate on the console.
88+
When you see this output on the console, AGL has been successfully loaded
89+
and now you can operate on the console.
9090

91-
Enable the display of AGL
91+
Enable the AGL display
9292
*************************
9393

94-
But following the setup steps before, you will get black screen in AGL.
94+
By following these setup steps, you will get a black screen in AGL.
9595
Please don't worry about it, and we will give the solutions to the black screen issue in AGL.
96-
By debugging, we identified the problem as an issue of ``ivi-shell.so`` library, it seems that
97-
this library is not well supported. But we can light the screen with the GUI of weston like figure below.
96+
By debugging, we identified the problem as an issue with the (not well supported) ``ivi-shell.so`` library.
97+
We can light the screen with the weston GUI, as shown below.
9898

9999
.. image:: images/The-GUI-of-weston.png
100100
:align: center
101101

102-
To enable weston in AGL, We need to modify ``weston.ini``, which is the configuration file of weston.
102+
To enable weston in AGL, we need to modify weston's ``weston.ini`` configuration file.
103103

104104
.. code-block:: none
105105
106106
$ vim /etc/xdg/weston/weston.ini
107107
108-
The changes of ``weston.ini``:
108+
Make these changes to ``weston.ini``:
109109

110110
#. Comment ``ivi-shell.so`` out
111111

112112
#. Check the name of output is ``HDMI-A-2``
113113

114-
After that, there are still some steps need to do to launch weston in AGL:
114+
After that, set up an environment variable and restart the weston service:
115115

116116
.. code-block:: none
117117
118118
$ export XDG_RUNTIME_DIR=/run/platform/display
119119
$ systemctl restart weston
120120
121-
And you will be able to see the GUI of weston in AGL now.
121+
You should now see the weston GUI in AGL.
122122

123123
Follow up
124124
*********
125-
ACRN Hypervisor is trying to support more kinds of operating systems all the time,
126-
and AGL is an example of them. We are still debugging the “ivi-shell.so” issue,
127-
and we are also investigating the problem why AGL GUI not got launched,
128-
currently it may either be a configuration issue or a real bug, more experiment will be done.
125+
ACRN Hypervisor is expanding support for more operating systems,
126+
and AGL is an example of this effort. We continue to debug the ``ivi-shell.so`` issue,
127+
and investigating why the AGL GUI is not launching as expected.

0 commit comments

Comments
 (0)