Move ACRN documentation in a dedicated doc/ folder

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>

.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

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.
 

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

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()

scripts/pullsource.sh

@@ -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