diff --git a/.gitignore b/.gitignore index 23a67b6fd..bcdcb45f3 100644 --- a/.gitignore +++ b/.gitignore @@ -3,8 +3,8 @@ hypervisor/bsp/uefi/include/bsp/version.h hypervisor/bsp/sbl/include/bsp/version.h devicemdodel/build/ devicemodel/include/version.h -doxygen -_build +doc/doxygen +doc/_build *.bak *.sav *.log diff --git a/.known-issues/README b/doc/.known-issues/README similarity index 100% rename from .known-issues/README rename to doc/.known-issues/README diff --git a/.known-issues/doc/hypercall.conf b/doc/.known-issues/doc/hypercall.conf similarity index 100% rename from .known-issues/doc/hypercall.conf rename to doc/.known-issues/doc/hypercall.conf diff --git a/CODEOWNERS b/doc/CODEOWNERS similarity index 100% rename from CODEOWNERS rename to doc/CODEOWNERS diff --git a/LICENSE b/doc/LICENSE similarity index 100% rename from LICENSE rename to doc/LICENSE diff --git a/Makefile b/doc/Makefile similarity index 87% rename from Makefile rename to doc/Makefile index 64776cc1c..447b7eacc 100644 --- a/Makefile +++ b/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. diff --git a/README.md b/doc/README.md similarity index 100% rename from README.md rename to doc/README.md diff --git a/_templates/breadcrumbs.html b/doc/_templates/breadcrumbs.html similarity index 100% rename from _templates/breadcrumbs.html rename to doc/_templates/breadcrumbs.html diff --git a/_templates/footer.html b/doc/_templates/footer.html similarity index 100% rename from _templates/footer.html rename to doc/_templates/footer.html diff --git a/acrn.doxyfile b/doc/acrn.doxyfile similarity index 99% rename from acrn.doxyfile rename to doc/acrn.doxyfile index cfe8ec149..96b54eae6 100644 --- a/acrn.doxyfile +++ b/doc/acrn.doxyfile @@ -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 diff --git a/api/devicemodel_api.rst b/doc/api/devicemodel_api.rst similarity index 100% rename from api/devicemodel_api.rst rename to doc/api/devicemodel_api.rst diff --git a/api/hypercall_api.rst b/doc/api/hypercall_api.rst similarity index 100% rename from api/hypercall_api.rst rename to doc/api/hypercall_api.rst diff --git a/api/index.rst b/doc/api/index.rst similarity index 100% rename from api/index.rst rename to doc/api/index.rst diff --git a/conf.py b/doc/conf.py similarity index 99% rename from conf.py rename to doc/conf.py index 9708d8e0a..ef5e46516 100644 --- a/conf.py +++ b/doc/conf.py @@ -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() diff --git a/contribute.rst b/doc/contribute.rst similarity index 100% rename from contribute.rst rename to doc/contribute.rst diff --git a/custom-doxygen/DoxygenLayout.xml b/doc/custom-doxygen/DoxygenLayout.xml similarity index 100% rename from custom-doxygen/DoxygenLayout.xml rename to doc/custom-doxygen/DoxygenLayout.xml diff --git a/custom-doxygen/customdoxygen.css b/doc/custom-doxygen/customdoxygen.css similarity index 100% rename from custom-doxygen/customdoxygen.css rename to doc/custom-doxygen/customdoxygen.css diff --git a/custom-doxygen/footer.html b/doc/custom-doxygen/footer.html similarity index 100% rename from custom-doxygen/footer.html rename to doc/custom-doxygen/footer.html diff --git a/custom-doxygen/header.html b/doc/custom-doxygen/header.html similarity index 100% rename from custom-doxygen/header.html rename to doc/custom-doxygen/header.html diff --git a/custom-doxygen/mainpage.md b/doc/custom-doxygen/mainpage.md similarity index 100% rename from custom-doxygen/mainpage.md rename to doc/custom-doxygen/mainpage.md diff --git a/custom-doxygen/standard-doxygen.css b/doc/custom-doxygen/standard-doxygen.css similarity index 100% rename from custom-doxygen/standard-doxygen.css rename to doc/custom-doxygen/standard-doxygen.css diff --git a/getting_started/images/gsg-bootmenu.png b/doc/getting_started/images/gsg-bootmenu.png similarity index 100% rename from getting_started/images/gsg-bootmenu.png rename to doc/getting_started/images/gsg-bootmenu.png diff --git a/getting_started/images/gsg-sos-console.png b/doc/getting_started/images/gsg-sos-console.png similarity index 100% rename from getting_started/images/gsg-sos-console.png rename to doc/getting_started/images/gsg-sos-console.png diff --git a/getting_started/images/gsg-successful-boot.png b/doc/getting_started/images/gsg-successful-boot.png similarity index 100% rename from getting_started/images/gsg-successful-boot.png rename to doc/getting_started/images/gsg-successful-boot.png diff --git a/getting_started/index.rst b/doc/getting_started/index.rst similarity index 100% rename from getting_started/index.rst rename to doc/getting_started/index.rst diff --git a/glossary.rst b/doc/glossary.rst similarity index 100% rename from glossary.rst rename to doc/glossary.rst diff --git a/hardware.rst b/doc/hardware.rst similarity index 100% rename from hardware.rst rename to doc/hardware.rst diff --git a/howtos/index.rst b/doc/howtos/index.rst similarity index 100% rename from howtos/index.rst rename to doc/howtos/index.rst diff --git a/howtos/process/acrn-doc-fork.png b/doc/howtos/process/acrn-doc-fork.png similarity index 100% rename from howtos/process/acrn-doc-fork.png rename to doc/howtos/process/acrn-doc-fork.png diff --git a/howtos/process/docbuild.rst b/doc/howtos/process/docbuild.rst similarity index 100% rename from howtos/process/docbuild.rst rename to doc/howtos/process/docbuild.rst diff --git a/howtos/tech/placeholder.rst b/doc/howtos/tech/placeholder.rst similarity index 100% rename from howtos/tech/placeholder.rst rename to doc/howtos/tech/placeholder.rst diff --git a/images/ACRN-favicon-32x32.png b/doc/images/ACRN-favicon-32x32.png similarity index 100% rename from images/ACRN-favicon-32x32.png rename to doc/images/ACRN-favicon-32x32.png diff --git a/images/ACRN_Logo_300w.png b/doc/images/ACRN_Logo_300w.png similarity index 100% rename from images/ACRN_Logo_300w.png rename to doc/images/ACRN_Logo_300w.png diff --git a/images/ACRN_Logo_56h.png b/doc/images/ACRN_Logo_56h.png similarity index 100% rename from images/ACRN_Logo_56h.png rename to doc/images/ACRN_Logo_56h.png diff --git a/images/ACRNlogo.png b/doc/images/ACRNlogo.png similarity index 100% rename from images/ACRNlogo.png rename to doc/images/ACRNlogo.png diff --git a/index.rst b/doc/index.rst similarity index 100% rename from index.rst rename to doc/index.rst diff --git a/introduction/images/IVI-block.png b/doc/introduction/images/IVI-block.png similarity index 100% rename from introduction/images/IVI-block.png rename to doc/introduction/images/IVI-block.png diff --git a/introduction/images/VMX-brief.png b/doc/introduction/images/VMX-brief.png similarity index 100% rename from introduction/images/VMX-brief.png rename to doc/introduction/images/VMX-brief.png diff --git a/introduction/images/architecture.png b/doc/introduction/images/architecture.png similarity index 100% rename from introduction/images/architecture.png rename to doc/introduction/images/architecture.png diff --git a/introduction/images/boot-flow.png b/doc/introduction/images/boot-flow.png similarity index 100% rename from introduction/images/boot-flow.png rename to doc/introduction/images/boot-flow.png diff --git a/introduction/images/device-model.png b/doc/introduction/images/device-model.png similarity index 100% rename from introduction/images/device-model.png rename to doc/introduction/images/device-model.png diff --git a/introduction/images/device-passthrough.png b/doc/introduction/images/device-passthrough.png similarity index 100% rename from introduction/images/device-passthrough.png rename to doc/introduction/images/device-passthrough.png diff --git a/introduction/images/io-emulation-path.png b/doc/introduction/images/io-emulation-path.png similarity index 100% rename from introduction/images/io-emulation-path.png rename to doc/introduction/images/io-emulation-path.png diff --git a/introduction/images/virtio-architecture.png b/doc/introduction/images/virtio-architecture.png similarity index 100% rename from introduction/images/virtio-architecture.png rename to doc/introduction/images/virtio-architecture.png diff --git a/introduction/images/virtio-framework-kernel.png b/doc/introduction/images/virtio-framework-kernel.png similarity index 100% rename from introduction/images/virtio-framework-kernel.png rename to doc/introduction/images/virtio-framework-kernel.png diff --git a/introduction/images/virtio-framework-userland.png b/doc/introduction/images/virtio-framework-userland.png similarity index 100% rename from introduction/images/virtio-framework-userland.png rename to doc/introduction/images/virtio-framework-userland.png diff --git a/introduction/index.rst b/doc/introduction/index.rst similarity index 100% rename from introduction/index.rst rename to doc/introduction/index.rst diff --git a/introduction/index.rst.sav b/doc/introduction/index.rst.sav similarity index 100% rename from introduction/index.rst.sav rename to doc/introduction/index.rst.sav diff --git a/primer/images/primer-dma-address-mapping.png b/doc/primer/images/primer-dma-address-mapping.png similarity index 100% rename from primer/images/primer-dma-address-mapping.png rename to doc/primer/images/primer-dma-address-mapping.png diff --git a/primer/images/primer-host-gdt.png b/doc/primer/images/primer-host-gdt.png similarity index 100% rename from primer/images/primer-host-gdt.png rename to doc/primer/images/primer-host-gdt.png diff --git a/primer/images/primer-hypervisor-interrupt.png b/doc/primer/images/primer-hypervisor-interrupt.png similarity index 100% rename from primer/images/primer-hypervisor-interrupt.png rename to doc/primer/images/primer-hypervisor-interrupt.png diff --git a/primer/images/primer-mem-layout.png b/doc/primer/images/primer-mem-layout.png similarity index 100% rename from primer/images/primer-mem-layout.png rename to doc/primer/images/primer-mem-layout.png diff --git a/primer/images/primer-pirq-routing.png b/doc/primer/images/primer-pirq-routing.png similarity index 100% rename from primer/images/primer-pirq-routing.png rename to doc/primer/images/primer-pirq-routing.png diff --git a/primer/images/primer-pv-mapping.png b/doc/primer/images/primer-pv-mapping.png similarity index 100% rename from primer/images/primer-pv-mapping.png rename to doc/primer/images/primer-pv-mapping.png diff --git a/primer/images/primer-sos-ept-mapping.png b/doc/primer/images/primer-sos-ept-mapping.png similarity index 100% rename from primer/images/primer-sos-ept-mapping.png rename to doc/primer/images/primer-sos-ept-mapping.png diff --git a/primer/images/primer-symmetric-io.png b/doc/primer/images/primer-symmetric-io.png similarity index 100% rename from primer/images/primer-symmetric-io.png rename to doc/primer/images/primer-symmetric-io.png diff --git a/primer/images/primer-uos-ept-mapping.png b/doc/primer/images/primer-uos-ept-mapping.png similarity index 100% rename from primer/images/primer-uos-ept-mapping.png rename to doc/primer/images/primer-uos-ept-mapping.png diff --git a/primer/images/primer-virtio-net.png b/doc/primer/images/primer-virtio-net.png similarity index 100% rename from primer/images/primer-virtio-net.png rename to doc/primer/images/primer-virtio-net.png diff --git a/primer/index.rst b/doc/primer/index.rst similarity index 100% rename from primer/index.rst rename to doc/primer/index.rst diff --git a/release_notes.rst b/doc/release_notes.rst similarity index 100% rename from release_notes.rst rename to doc/release_notes.rst diff --git a/scripts/filter-doc-log.sh b/doc/scripts/filter-doc-log.sh similarity index 100% rename from scripts/filter-doc-log.sh rename to doc/scripts/filter-doc-log.sh diff --git a/scripts/filter-known-issues.py b/doc/scripts/filter-known-issues.py similarity index 100% rename from scripts/filter-known-issues.py rename to doc/scripts/filter-known-issues.py diff --git a/scripts/publish-README.md b/doc/scripts/publish-README.md similarity index 100% rename from scripts/publish-README.md rename to doc/scripts/publish-README.md diff --git a/scripts/publish-index.html b/doc/scripts/publish-index.html similarity index 100% rename from scripts/publish-index.html rename to doc/scripts/publish-index.html diff --git a/scripts/requirements.txt b/doc/scripts/requirements.txt similarity index 100% rename from scripts/requirements.txt rename to doc/scripts/requirements.txt diff --git a/static/acrn-custom.css b/doc/static/acrn-custom.css similarity index 100% rename from static/acrn-custom.css rename to doc/static/acrn-custom.css diff --git a/static/jquery.js b/doc/static/jquery.js similarity index 100% rename from static/jquery.js rename to doc/static/jquery.js diff --git a/scripts/pullsource.sh b/scripts/pullsource.sh deleted file mode 100755 index 6cb78cc82..000000000 --- a/scripts/pullsource.sh +++ /dev/null @@ -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