David B. Kinder 42d9b24a54 doc: allow overriding displayed doc version ...

In special cases, we'd like to freeze doc versions based on a tag (e.g.,
tags/acrn-2018w34.4-140000p) and have that version show up on the
generated docs.  (Normally the version shown is from the
hypervisor/VERSION file.)

With this patch, if DOC_TAG=release then it uses a RELEASE=name
environment variable (e.g., from the make command line) to override the
displayed version:

    make DOC_TAG=release RELEASE=acrn-2018w34.4-140000p html
    make DOC_TAG=release RELEASE=acrn-2018w34.4-140000p publish

Assuming you've checked out the tagged branch (both for acrn-hypervisor
and acrn-kernel), these make commands will generate and publish docs to
https://projectacrn.github.io/acrn-2018w34.4-14000p

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>

2018-09-11 16:29:17 -07:00

9.0 KiB

Raw Blame History

View Raw