From 98a3d0d2cf24fe373bf1357ed12973e6194dc361 Mon Sep 17 00:00:00 2001
From: "David B. Kinder" <david.b.kinder@intel.com>
Date: Tue, 7 Jun 2022 17:21:53 -0700
Subject: [PATCH] doc: parameterize hidden config option doc generation

Add a configuration parameter for the xsltproc processing to decide
whether to include hidden options.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
---
 doc/Makefile              | 7 +++++--
 doc/scripts/configdoc.xsl | 9 +++++++--
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/doc/Makefile b/doc/Makefile
index 2bd6e5140..9729cb358 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -13,7 +13,10 @@ SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = "Project ACRN"
 BUILDDIR      ?= _build
 SOURCEDIR     = $(BUILDDIR)/rst
-LATEXMKOPTS   = "-silent -interaction=nonstopmode -f"
+LATEXMKOPTS   = -silent
+
+# should the config option doc show hidden config options?
+XSLTPARAM     ?= --stringparam showHidden 'n'
 
 # document publication assumes the folder structure is setup
 # with the acrn-hypervisor and projectacrn.github.io repos as
@@ -54,7 +57,7 @@ content:
 	$(Q)scripts/extract_content.py $(SOURCEDIR) misc
 	$(Q)mkdir -p $(SOURCEDIR)/misc/config_tools/schema
 	$(Q)rsync -rt ../misc/config_tools/schema/*.xsd $(SOURCEDIR)/misc/config_tools/schema
-	$(Q)xsltproc -xinclude ./scripts/configdoc.xsl $(SOURCEDIR)/misc/config_tools/schema/config.xsd > $(SOURCEDIR)/reference/configdoc.txt
+	$(Q)xsltproc $(XSLTPARAM) -xinclude ./scripts/configdoc.xsl $(SOURCEDIR)/misc/config_tools/schema/config.xsd > $(SOURCEDIR)/reference/configdoc.txt
 
 
 html: content doxy
diff --git a/doc/scripts/configdoc.xsl b/doc/scripts/configdoc.xsl
index 2cd8d4d24..035a562b5 100644
--- a/doc/scripts/configdoc.xsl
+++ b/doc/scripts/configdoc.xsl
@@ -5,6 +5,8 @@
   <xsl:variable name="section_adornment" select="'#*=-%+@`'"/>
   <xsl:variable name="vLower" select="'abcdefghijklmnopqrstuvwxyz'"/>
   <xsl:variable name="vUpper" select="'ABCDEFGHIJKLMNOPQRSTUVWXYZ'"/>
+  <!-- Default is to not show hidden options (acrn:views='') overridded by passing - -paramstring showHidden 'y' to xsltproc -->
+  <xsl:param name="showHidden" select="n" />
   <!-- xslt script to autogenerate config option documentation -->
   <!-- Get things started with the ACRNConfigType element -->
   <xsl:template match="/xs:schema">
@@ -56,9 +58,9 @@
     <!-- Only visit elements having complex types. Those having simple types are
          described as an option -->
     <xsl:choose>
-      <xsl:when test="xs:annotation/@acrn:views=''">
         <!-- don't document elements if not viewable -->
-      </xsl:when>
+        <xsl:when test="xs:annotation/@acrn:views='' and $showHidden='n'">
+        </xsl:when>
       <xsl:when test="//xs:complexType[@name=$ty]">
         <!-- The section header -->
           <xsl:if test="$level &lt;= 4">
@@ -136,6 +138,9 @@
             <xsl:when test="xs:annotation/@acrn:views=''">
               <xsl:text>|icon-not-available| </xsl:text>
             </xsl:when>
+            <xsl:when test="$parent/xs:annotation/@acrn:views=''">
+              <xsl:text>|icon-not-available| </xsl:text>
+            </xsl:when>
             <xsl:otherwise>
                 <xsl:choose>
                     <xsl:when test="count(ancestor-or-self::node()[xs:annotation[@acrn:views]])!=0">