Skip to content

Commit 12fb4b0

Browse files
Geoffroy Van Cutsemjren1
authored andcommitted
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>
1 parent 60c07fb commit 12fb4b0

File tree

9 files changed

+20
-57
lines changed

9 files changed

+20
-57
lines changed

doc/Makefile

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,19 @@ BUILDDIR = _build
1616

1717
DOC_TAG ?= development
1818
RELEASE ?= latest
19-
PUBLISHDIR = ../projectacrn.github.io/$(RELEASE)
19+
PUBLISHDIR = ../../projectacrn.github.io/$(RELEASE)
2020

2121
# Put it first so that "make" without argument is like "make help".
2222
help:
2323
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2424
@echo ""
25-
@echo "make pullsource"
26-
@echo " fetch and merge upstream source for the project ACRN code repos"
27-
@echo ""
2825
@echo "make publish"
2926
@echo " publish generated html to projectacrn.github.io site:"
3027
@echo " specify RELEASE=name to publish as a tagged release version"
31-
@echo " and placed in a version subfolder"
28+
@echo " and placed in a version subfolder. Requires repo merge permission."
3229

3330
.PHONY: help Makefile
3431

35-
pullsource:
36-
$(Q)scripts/pullsource.sh
37-
38-
3932
# Generate the doxygen xml (for Sphinx) and copy the doxygen html to the
4033
# api folder for publishing along with the Sphinx-generated API docs.
4134

doc/acrn.doxyfile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -791,10 +791,10 @@ WARN_LOGFILE =
791791
# Note: If this tag is empty the current directory is searched.
792792

793793
INPUT = custom-doxygen/mainpage.md \
794-
../acrn-hypervisor/include/common/hypercall.h \
795-
../acrn-hypervisor/include/public/acrn_common.h \
796-
../acrn-hypervisor/include/public/acrn_hv_defs.h \
797-
../acrn-devicemodel/include/virtio.h
794+
../hypervisor/include/common/hypercall.h \
795+
../hypervisor/include/public/acrn_common.h \
796+
../hypervisor/include/public/acrn_hv_defs.h \
797+
../devicemodel/include/virtio.h
798798

799799

800800
# This tag can be used to specify the character encoding of the source files

doc/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
version_major = None
6464
version_minor = None
6565
version_rc = None
66-
for line in open(os.path.normpath("../acrn-hypervisor/Makefile")) :
66+
for line in open(os.path.normpath("../hypervisor/Makefile")) :
6767
# remove comments
6868
line = line.split('#', 1)[0]
6969
line = line.rstrip()
@@ -93,7 +93,7 @@
9393
#
9494
# The short X.Y version.
9595
# version = u'0.1'
96-
# The full version, including alpha/doc/beta/doc/rc tags.
96+
# The full version, including alpha/beta/rc tags.
9797
# release = u'0.1'
9898

9999
# The language for content autogenerated by Sphinx. Refer to documentation

doc/getting_started/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ Set up Reference UOS
270270
271271
# losetup -f -P --show /root/clear-22140-kvm.img
272272
# mount /dev/loop0p3 /mnt
273-
# cp -r /usr/lib/doc/modules/4.14.34-28.pk414-standard /mnt/lib/doc/modules/
273+
# cp -r /usr/lib/modules/4.14.34-28.pk414-standard /mnt/lib/modules/
274274
# umount /mnt
275275
# sync
276276
@@ -293,7 +293,7 @@ Set up Reference UOS
293293
and version number highlighted above (the ``-s 3,virtio-blk`` argument) to match
294294
what you have downloaded above. Likewise, you may need to adjust the kernel file
295295
name on the second line highlighted (check the exact name to be used using:
296-
``ls /usr/lib/doc/kernel/org.clearlinux*-standard*``).
296+
``ls /usr/lib/kernel/org.clearlinux*-standard*``).
297297

298298
By default, the script is located in the ``/usr/share/acrn/demo/``
299299
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:
340340
libpciaccess-dev \
341341
uuid-dev
342342
343-
* On a Fedora/doc/Redhat development system:
343+
* On a Fedora/Redhat development system:
344344

345345
.. code-block:: console
346346

doc/howtos/tech/placeholder.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.. _wip:
2-
3-
Work in Progress
4-
################
5-
6-
This is a placeholder doc for technical how-to articles in-progress.
1+
.. _wip:
2+
3+
Work in Progress
4+
################
5+
6+
This is a placeholder doc for technical how-to articles in-progress.

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Source code for Project ACRN is maintained in the
1313
license.
1414

1515
.. _BSD 3-clause license:
16-
https://github.com/projectacrn/acrn-hypervisor/blob/doc/master/LICENSE
16+
https://github.com/projectacrn/acrn-hypervisor/blob/master/LICENSE
1717

1818
.. _Project ACRN GitHub repo: https://github.com/projectacrn
1919

doc/primer/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ ACRN hypervisor source tree
5353
include files for all public APIs (doxygen comments in these source
5454
files are used to generate the :ref:`acrn_apis` documentation)
5555

56-
**lib/doc/**
56+
**lib/**
5757
runtime service libraries
5858

5959
ACRN Device Model source tree

doc/scripts/pullsource.sh

Lines changed: 0 additions & 30 deletions
This file was deleted.

doc/static/jquery.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)