mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-06-19 04:02:05 +00:00
doc: Adjust various scripts accordingly
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com> Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
parent
60c07fba51
commit
12fb4b0584
11
doc/Makefile
11
doc/Makefile
@ -16,26 +16,19 @@ BUILDDIR = _build
|
||||
|
||||
DOC_TAG ?= development
|
||||
RELEASE ?= latest
|
||||
PUBLISHDIR = ../projectacrn.github.io/$(RELEASE)
|
||||
PUBLISHDIR = ../../projectacrn.github.io/$(RELEASE)
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
@echo ""
|
||||
@echo "make pullsource"
|
||||
@echo " fetch and merge upstream source for the project ACRN code repos"
|
||||
@echo ""
|
||||
@echo "make publish"
|
||||
@echo " publish generated html to projectacrn.github.io site:"
|
||||
@echo " specify RELEASE=name to publish as a tagged release version"
|
||||
@echo " and placed in a version subfolder"
|
||||
@echo " and placed in a version subfolder. Requires repo merge permission."
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
pullsource:
|
||||
$(Q)scripts/pullsource.sh
|
||||
|
||||
|
||||
# Generate the doxygen xml (for Sphinx) and copy the doxygen html to the
|
||||
# api folder for publishing along with the Sphinx-generated API docs.
|
||||
|
||||
|
@ -791,10 +791,10 @@ WARN_LOGFILE =
|
||||
# Note: If this tag is empty the current directory is searched.
|
||||
|
||||
INPUT = custom-doxygen/mainpage.md \
|
||||
../acrn-hypervisor/include/common/hypercall.h \
|
||||
../acrn-hypervisor/include/public/acrn_common.h \
|
||||
../acrn-hypervisor/include/public/acrn_hv_defs.h \
|
||||
../acrn-devicemodel/include/virtio.h
|
||||
../hypervisor/include/common/hypercall.h \
|
||||
../hypervisor/include/public/acrn_common.h \
|
||||
../hypervisor/include/public/acrn_hv_defs.h \
|
||||
../devicemodel/include/virtio.h
|
||||
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
|
@ -63,7 +63,7 @@ try:
|
||||
version_major = None
|
||||
version_minor = None
|
||||
version_rc = None
|
||||
for line in open(os.path.normpath("../acrn-hypervisor/Makefile")) :
|
||||
for line in open(os.path.normpath("../hypervisor/Makefile")) :
|
||||
# remove comments
|
||||
line = line.split('#', 1)[0]
|
||||
line = line.rstrip()
|
||||
@ -93,7 +93,7 @@ finally:
|
||||
#
|
||||
# The short X.Y version.
|
||||
# version = u'0.1'
|
||||
# The full version, including alpha/doc/beta/doc/rc tags.
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
# release = u'0.1'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
|
@ -270,7 +270,7 @@ Set up Reference UOS
|
||||
|
||||
# losetup -f -P --show /root/clear-22140-kvm.img
|
||||
# mount /dev/loop0p3 /mnt
|
||||
# cp -r /usr/lib/doc/modules/4.14.34-28.pk414-standard /mnt/lib/doc/modules/
|
||||
# cp -r /usr/lib/modules/4.14.34-28.pk414-standard /mnt/lib/modules/
|
||||
# umount /mnt
|
||||
# sync
|
||||
|
||||
@ -293,7 +293,7 @@ Set up Reference UOS
|
||||
and version number highlighted above (the ``-s 3,virtio-blk`` argument) to match
|
||||
what you have downloaded above. Likewise, you may need to adjust the kernel file
|
||||
name on the second line highlighted (check the exact name to be used using:
|
||||
``ls /usr/lib/doc/kernel/org.clearlinux*-standard*``).
|
||||
``ls /usr/lib/kernel/org.clearlinux*-standard*``).
|
||||
|
||||
By default, the script is located in the ``/usr/share/acrn/demo/``
|
||||
directory. You can edit it there, and then run it to launch the User OS:
|
||||
@ -340,7 +340,7 @@ each with their own way to install development tools:
|
||||
libpciaccess-dev \
|
||||
uuid-dev
|
||||
|
||||
* On a Fedora/doc/Redhat development system:
|
||||
* On a Fedora/Redhat development system:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
|
@ -13,7 +13,7 @@ Source code for Project ACRN is maintained in the
|
||||
license.
|
||||
|
||||
.. _BSD 3-clause license:
|
||||
https://github.com/projectacrn/acrn-hypervisor/blob/doc/master/LICENSE
|
||||
https://github.com/projectacrn/acrn-hypervisor/blob/master/LICENSE
|
||||
|
||||
.. _Project ACRN GitHub repo: https://github.com/projectacrn
|
||||
|
||||
|
@ -53,7 +53,7 @@ ACRN hypervisor source tree
|
||||
include files for all public APIs (doxygen comments in these source
|
||||
files are used to generate the :ref:`acrn_apis` documentation)
|
||||
|
||||
**lib/doc/**
|
||||
**lib/**
|
||||
runtime service libraries
|
||||
|
||||
ACRN Device Model source tree
|
||||
|
@ -1,30 +0,0 @@
|
||||
#!/bin/bash
|
||||
|
||||
q="--quiet"
|
||||
|
||||
# pull fresh copies of the ACRN source for use by doxygen
|
||||
|
||||
if [ ! -d "../acrn-hypervisor" ]; then
|
||||
echo Repo for acrn-hypervisor is missing.
|
||||
exit -1
|
||||
fi
|
||||
if [ ! -d "../acrn-devicemodel" ]; then
|
||||
echo Repo for acrn-devicemodel is missing.
|
||||
exit -1
|
||||
fi
|
||||
|
||||
# Assumes origin (personal) and upstream (project) remote repos are
|
||||
# setup
|
||||
|
||||
cd ../acrn-hypervisor
|
||||
git checkout $q master;
|
||||
git fetch $q upstream
|
||||
git merge $q upstream/master
|
||||
git push $q origin master
|
||||
|
||||
|
||||
cd ../acrn-devicemodel
|
||||
git checkout $q master;
|
||||
git fetch $q upstream
|
||||
git merge $q upstream/master
|
||||
git push $q origin master
|
2
doc/static/jquery.js
vendored
2
doc/static/jquery.js
vendored
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue
Block a user