github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-09-10 21:29:20 +00:00
Code Issues Projects Releases Wiki Activity

doc: add script for syncing acrn-kernel for API gen

Browse Source 
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>
This commit is contained in:
David B. Kinder
2018-07-24 16:57:40 -07:00
committed by David Kinder
parent 363a84c7b8
commit 3abfdbab72
3 changed files with 40 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/tutorials/docbuild.rst
View File

@@ -66,9 +66,14 @@ generation:
devicemodel/
doc/
hypervisor/
acrn-kernel
The parent projectacrn folder is there because we'll also be creating a
publishing area later in these steps. It's best if the acrn-hypervisor
publishing area later in these steps. For API doc generation, we'll also
need the acrn-kernel repo contents in a sibling folder to the
acrn-hypervisor repo contents.
It's best if the acrn-hypervisor
folder is an ssh clone of your personal fork of the upstream project
repos (though https clones work too):
@@ -96,6 +101,19 @@ repos (though https clones work too):
cd acrn-hypervisor
git remote add upstream git@github.com:projectacrn/acrn-hypervisor.git
#. For API doc generation we'll also need the acrn-kernel repo available
locally:
.. code-block:: bash
cd ..
git clone git@github.com:projectacrn/acrn-kernel.git
.. note:: We assume for doc generation that ``origin`` is pointed to
the upstream repo. If you're a developer and have the acrn-kernel
repo allready set up as a sibling folder to the acrn-hypervisor,
you can skip this clone step.
#. If you haven't do so already, be sure to configure git with your name
and email address for the signed-off-by line in your commit messages: