github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-22 13:37:10 +00:00
Code Issues Projects Releases Wiki Activity

doc: post-merge changes to docs

Browse Source 
Documentation updates were needed to account for changes caused by the
recent merging of the three acrn-hypervisor, acrn-devicemodel, and
acrn-documentation repos.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2018-05-11 10:05:05 -07:00 committed by Jack Ren
parent 12fb4b0584
commit f8861806f0
6 changed files with 59 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/Makefile
View File

@ -32,7 +32,6 @@ help:
# Generate the doxygen xml (for Sphinx) and copy the doxygen html to the # Generate the doxygen xml (for Sphinx) and copy the doxygen html to the
# api folder for publishing along with the Sphinx-generated API docs. # api folder for publishing along with the Sphinx-generated API docs.
#doxy: pullsource
doxy: doxy:
$(Q)(cat acrn.doxyfile) | doxygen - > doc.log 2>&1 $(Q)(cat acrn.doxyfile) | doxygen - > doc.log 2>&1

4
doc/README.md
View File

@ -1,5 +1,5 @@
# Project ACRN Documentation Repo # Project ACRN Documentation
This repository hold the source and configuration files used to generate the This folder hold the source and configuration files used to generate the
Project ACRN documentation web site published to Project ACRN documentation web site published to
https://projectacrn.github.io https://projectacrn.github.io

57
doc/contribute.rst
View File

@ -107,7 +107,7 @@ as introduced in the project ACRN `Getting Started Guide`_.
.. _Getting Started Guide: .. _Getting Started Guide:
https://projectacrn.github.io/getting_started/ https://projectacrn.github.io/getting_started/
You should be familiar with common developer tools such as Git, and You should be familiar with common developer tools such as Git and
platforms such as GitHub. platforms such as GitHub.
If you haven't already done so, you'll need to create a (free) GitHub account If you haven't already done so, you'll need to create a (free) GitHub account
@ -116,20 +116,13 @@ on https://github.com and have Git tools available on your development system.
Repository layout Repository layout
***************** *****************
To clone the ACRN hypervisor repository use:: To clone the ACRN hypervisor repository (including the hypervisor,
devicemodel, and doc folders) use::
git clone https://github.com/projectacrn/acrn-hypervisor git clone https://github.com/projectacrn/acrn-hypervisor
To clone the ACRN device model repository use:: The project ACRN directory structure is described in the :ref:`primer`
document. In addition to the ACRN hypervisor and device model itself,
git clone https://github.com/projectacrn/acrn-devicemodel
To clone the ACRN documentation repository use::
git clone https://github.com/projectacrn/acrn-documentation
The project ACRN directory structure is described in the `Hypervisor
Primer`_ document. In addition to the ACRN hypervisor and device model itself,
you'll also find the sources for technical documentation available from you'll also find the sources for technical documentation available from
the `ACRN documentation site`_. All of these are available for the `ACRN documentation site`_. All of these are available for
developers to contribute to and enhance. developers to contribute to and enhance.
@ -137,9 +130,6 @@ developers to contribute to and enhance.
.. _ACRN documentation site: .. _ACRN documentation site:
https://projectacrn.github.io/ https://projectacrn.github.io/
.. _Hypervisor Primer:
https://projectacrn.github.io/hypervisor_primer
Submitting Issues Submitting Issues
****************** ******************
@ -223,8 +213,8 @@ and test your changes thoroughly before submitting.
The general GitHub workflow used by project ACRN developers uses a combination of The general GitHub workflow used by project ACRN developers uses a combination of
command line Git commands and browser interaction with GitHub. As it is with command line Git commands and browser interaction with GitHub. As it is with
Git, there are multiple ways of getting a task done. We'll describe a typical Git, there are multiple ways of getting a task done. We'll describe a typical
workflow here for the acrn-hypervisor repo that can also be used for the workflow here for the acrn-hypervisor repo, which includes the
acrn-devicemodel and acrn-documentation repos: source files for the hypervisor, devicemodel, and documentation:
.. _Create a Fork of acrn-hypervisor: .. _Create a Fork of acrn-hypervisor:
https://github.com/projectacrn/acrn-hypervisor#fork-destination-box https://github.com/projectacrn/acrn-hypervisor#fork-destination-box
@ -232,6 +222,9 @@ acrn-devicemodel and acrn-documentation repos:
#. `Create a Fork of acrn-hypervisor`_ #. `Create a Fork of acrn-hypervisor`_
to your personal account on GitHub. (Click on the fork button in the top to your personal account on GitHub. (Click on the fork button in the top
right corner of the project acrn-hypervisor repo page in GitHub.) right corner of the project acrn-hypervisor repo page in GitHub.)
When you want to submit a pull request with your changes, you'll
first submit them to your personal branch, and then to the project's
master branch for review and merging by the ACRN maintainers.
#. On your development computer, clone the fork you just made:: #. On your development computer, clone the fork you just made::
@ -251,6 +244,8 @@ acrn-devicemodel and acrn-documentation repos:
git checkout master git checkout master
git checkout -b fix_comment_typo git checkout -b fix_comment_typo
Give your branch a short descriptive name.
#. Make changes, test locally, change, test, test again, ... #. Make changes, test locally, change, test, test again, ...
#. When things look good, start the pull request process by checking #. When things look good, start the pull request process by checking
@ -260,9 +255,9 @@ acrn-devicemodel and acrn-documentation repos:
Then add the changed files:: Then add the changed files::
git add [file(s) that changed, add -p if you want to be more specific] git add [file(s) that changed]
(or to have all changed files added use):: (or to have all changed files staged, use)::
git add -A git add -A
@ -286,7 +281,7 @@ acrn-devicemodel and acrn-documentation repos:
#. In your web browser, go to your personal forked repo and click on the Compare & pull #. In your web browser, go to your personal forked repo and click on the Compare & pull
request button for the branch you just worked on and you want to request button for the branch you just worked on and you want to
submit to the upstream repo. submit to the upstream ACRN repo.
#. Review the pull request changes, and verify that you are opening a pull request #. Review the pull request changes, and verify that you are opening a pull request
for the appropriate branch. The title and message from your commit message should for the appropriate branch. The title and message from your commit message should
@ -294,7 +289,8 @@ acrn-devicemodel and acrn-documentation repos:
#. GitHub will assign one or more suggested reviewers (based on the CODEOWNERS file #. GitHub will assign one or more suggested reviewers (based on the CODEOWNERS file
in the repo). If you are a project member, you can select additional reviewers in the repo). If you are a project member, you can select additional reviewers
now too. now too. If no reviewers are selected, the ACRN triage team will
assign reviewers as appropriate.
#. Click on the submit button and your pull request is sent and awaits review. #. Click on the submit button and your pull request is sent and awaits review.
Email will be sent as review comments are made, or you can check on your Email will be sent as review comments are made, or you can check on your
@ -309,19 +305,24 @@ acrn-devicemodel and acrn-documentation repos:
and use the same process described above to work on this new topic branch. and use the same process described above to work on this new topic branch.
#. If reviewers do request changes to your patch, you can interactively rebase #. If reviewers request changes to your patch, you can interactively rebase
commit(s) to fix review issues. In your development repo, make the commit(s) to fix review issues. In your development repo, make the
needed changes on the branch you made the initial submission:: needed changes on the branch you made the initial submission::
git checkout fix-comment-typo git checkout fix-comment-typo
then:: make the requested changes, and then::
git fetch --all git fetch --all
git rebase --ignore-whitespace upstream/master git rebase --ignore-whitespace upstream/master
The ``--ignore-whitespace`` option stops git apply (called by rebase) from changing This is an important step to make sure your changes are properly
any whitespace. Continuing:: merged with changes from other developers that may have happened while you
were working on your changes.
The ``--ignore-whitespace`` option
stops ``git apply`` (called by rebase) from changing
any whitespace. If any merging issues are detected you can address them
with::
git rebase -i <offending-commit-id> git rebase -i <offending-commit-id>
@ -367,11 +368,7 @@ Changes are submitted as Git commits. Each commit message must contain:
* If the change addresses an issue, include a line of the form:: * If the change addresses an issue, include a line of the form::
Fixes #<issue number> Fixes #<brief description about the reported issue>.
See `Closing issues using keywords
<https://help.github.com/articles/closing-issues-using-keywords>`_
for more information about this GitHub feature.
All changes and topics sent to GitHub must be well-formed, as described above. All changes and topics sent to GitHub must be well-formed, as described above.

31
doc/getting_started/index.rst
View File

@ -165,12 +165,12 @@ partition. Follow these steps:
+-----------+----------------------------------------------------------------+ +-----------+----------------------------------------------------------------+
A starter acrn.conf configuration file is included in the Clear Linux release and is A starter acrn.conf configuration file is included in the Clear Linux release and is
also available in the acrn-hypervisor GitHub repo as `acrn.conf also available in the acrn-hypervisor/hypervisor GitHub repo as `acrn.conf
<https://github.com/projectacrn/acrn-hypervisor/tree/master/bsp/uefi/clearlinux/acrn.conf>`__ <https://github.com/projectacrn/acrn-hypervisor/hypervisor/tree/master/bsp/uefi/clearlinux/acrn.conf>`__
as shown here: as shown here:
.. literalinclude:: ../../acrn-hypervisor/bsp/uefi/clearlinux/acrn.conf .. literalinclude:: ../../hypervisor/bsp/uefi/clearlinux/acrn.conf
:caption: acrn-hypervisor/bsp/uefi/clearlinux/acrn.conf :caption: hypervisor/bsp/uefi/clearlinux/acrn.conf
On the NUC, copy the ``acrn.conf`` file to the EFI partition we mounted earlier: On the NUC, copy the ``acrn.conf`` file to the EFI partition we mounted earlier:
@ -223,13 +223,13 @@ Without a network bridge, the SOS and UOS are not able to talk to each
other. other.
A sample `bridge.sh A sample `bridge.sh
<https://github.com/projectacrn/acrn-devicemodel/tree/master/samples/bridge.sh>`__ <https://github.com/projectacrn/acrn-hypervisor/devicemodel/tree/master/samples/bridge.sh>`__
is included in the Clear Linux release, and is included in the Clear Linux release, and
is also available in the acrn-devicemodel GitHub repo (in the samples is also available in the acrn-hypervisor/devicemodel GitHub repo (in the samples
folder) as shown here: folder) as shown here:
.. literalinclude:: ../../acrn-devicemodel/samples/bridge.sh .. literalinclude:: ../../devicemodel/samples/bridge.sh
:caption: acrn-devicemodel/samples/bridge.sh :caption: devicemodel/samples/bridge.sh
:language: bash :language: bash
By default, the script is located in the ``/usr/share/acrn/demo/`` By default, the script is located in the ``/usr/share/acrn/demo/``
@ -277,13 +277,13 @@ Set up Reference UOS
#. Edit and Run the launch_uos.sh script to launch the UOS. #. Edit and Run the launch_uos.sh script to launch the UOS.
A sample `launch_uos.sh A sample `launch_uos.sh
<https://github.com/projectacrn/acrn-devicemodel/tree/master/samples/launch_uos.sh>`__ <https://github.com/projectacrn/acrn-hypervisor/devicemodel/tree/master/samples/launch_uos.sh>`__
is included in the Clear Linux release, and is included in the Clear Linux release, and
is also available in the acrn-devicemodel GitHub repo (in the samples is also available in the acrn-hypervisor/devicemodel GitHub repo (in the samples
folder) as shown here: folder) as shown here:
.. literalinclude:: ../../acrn-devicemodel/samples/launch_uos.sh .. literalinclude:: ../../devicemodel/samples/launch_uos.sh
:caption: acrn-devicemodel/samples/launch_uos.sh :caption: devicemodel/samples/launch_uos.sh
:language: bash :language: bash
:emphasize-lines: 22,24 :emphasize-lines: 22,24
@ -368,17 +368,16 @@ Build the hypervisor and device model
.. code-block:: console .. code-block:: console
$ git clone https://github.com/projectacrn/acrn-hypervisor $ git clone https://github.com/projectacrn/acrn-hypervisor
$ cd acrn-hypervisor $ cd acrn-hypervisor/hypervisor
$ make PLATFORM=uefi $ make PLATFORM=uefi
The build results are found in the ``build`` directory. The build results are found in the ``build`` directory.
#. Download the ACRN device model and build it. #. Build the ACRN device model (included in the acrn-hypervisor repo):
.. code-block:: console .. code-block:: console
$ git clone https://github.com/projectacrn/acrn-devicemodel $ cd ../devicemodel
$ cd acrn-devicemodel
$ make $ make
The build results are found in the ``build`` directory. The build results are found in the ``build`` directory.

14
doc/primer/index.rst
View File

@ -59,6 +59,9 @@ ACRN hypervisor source tree
ACRN Device Model source tree ACRN Device Model source tree
============================= =============================
**arch/x86/**
architecture-specific source files needed for the devicemodel
**core/** **core/**
ACRN Device model core logic (main loop, SOS interface, etc.) ACRN Device model core logic (main loop, SOS interface, etc.)
@ -92,6 +95,10 @@ reading now.) Developers can view this content either in its raw form as
the HTML content and view it with a web browser directly on your the HTML content and view it with a web browser directly on your
workstation, useful if you're contributing documentation to the project. workstation, useful if you're contributing documentation to the project.
**_templates/**
Sphinx configuration updates for the standard read-the-docs templates
used to format the generated HTML output
**api/** **api/**
ReST files for API document generation ReST files for API document generation
@ -103,8 +110,8 @@ workstation, useful if you're contributing documentation to the project.
**getting_started/** **getting_started/**
ReST files and images for the Getting Started Guide ReST files and images for the Getting Started Guide
**primer/** **howtos/**
ReST files and images for the Developer Primer ReST files and images for Technical and Process how-to articles
**images/** **images/**
Image files not specific to a document (logos, and such) Image files not specific to a document (logos, and such)
@ -112,6 +119,9 @@ workstation, useful if you're contributing documentation to the project.
**introduction/** **introduction/**
ReST files and images for the Introduction to Project ACRN ReST files and images for the Introduction to Project ACRN
**primer/**
ReST files and images for the Developer Primer
**scripts/** **scripts/**
Files used to assist building the documentation set Files used to assist building the documentation set

5
doc/scripts/publish-README.md
View File

@ -1,5 +1,6 @@
# projectacrn.github.io # projectacrn.github.io
This is the Project ACRN Documentation Publishing site for GitHub Pages. This is the Project ACRN Documentation Publishing site for GitHub Pages.
Content changes are not made directly in this repo. Instead, edit content Content changes are not made directly in this repo. Instead, edit content
in the acrn-documentation repo, re-generate the HTML with Sphinx, and push in the acrn-hypervisor repo's /doc folder, re-generate the HTML with
the updated content here for publishing. Sphinx (make html), and push the updated content here for publishing
(make publish)..