VirtualBox

Changeset 56533 in vbox


Ignore:
Timestamp:
Jun 18, 2015 6:15:51 PM (10 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
101155
Message:

VBoxManage generated help updates, manual/Makefile.kmk hacking, related stuff.

Location:
trunk
Files:
5 edited
3 moved

Legend:

Unmodified
Added
Removed

  • trunk/doc/manual/Makefile.kmk

    r56527 r56533  
    101101# xsltproc with the catalog trick if applicable.
    102102ifdef VBOX_XML_CATALOG
    103  VBOX_XSLTPROC_WITH_CAT    = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" -- $(VBOX_XSLTPROC)
    104  VBOX_XMLLINT_WITH_CAT     = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" -- $(VBOX_XMLLINT)
     103 VBOX_XSLTPROC_WITH_CAT    = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" -- \
     104        $(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS)
     105 VBOX_XMLLINT_WITH_CAT     = $(REDIRECT) -E "XML_CATALOG_FILES=$(VBOX_XML_CATALOG)" -- \
     106        $(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS)
    105107else
    106  VBOX_XSLTPROC_WITH_CAT    = $(VBOX_XSLTPROC)
    107  VBOX_XMLLINT_WITH_CAT     = $(VBOX_XMLLINT)
     108 VBOX_XSLTPROC_WITH_CAT    = $(VBOX_XSLTPROC) --nonet --xinclude $(VBOX_XSLTPROC_OPTS)
     109 VBOX_XMLLINT_WITH_CAT     = $(VBOX_XMLLINT) --nonet --xinclude --noout $(VBOX_XMLLINT_OPTS)
    108110endif
    109111
    … …  
    165167## List of refentry files (manpages).
    166168VBOX_MANUAL_XML_REFENTRY_FILES = \
    167         man_VBoxManage_debugvm.xml \
    168         man_VBoxManage_extpack.xml
     169        man_VBoxManage-debugvm.xml \
     170        man_VBoxManage-extpack.xml
    169171
    170172
    … …  
    283285                $(VBOX_MANUAL_XML_FILES_INCL_CHANGELOG) \
    284286               $(VBOX_MANUAL_XML_REFENTRY_FILES) \
     287               $(addprefix user_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
     288               $(patsubst man_%,%.1,$(basename $(VBOX_MANUAL_XML_REFENTRY_FILES))) \
    285289                $(VBOX_MANUAL_LATEX_FILES_TARGET) \
    286290                $(VBOX_MANUAL_PNG_FILES_$(lang)) \
    … …  
    466470$(foreach lang,$(VBOX_MANUAL_LANGUAGES), \
    467471$(eval $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/user_VBoxManage.xml: $(VBOX_PATH_MANUAL_SRC)/$(lang)/user_VBoxManage.xml \
    468         $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
     472        $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/user_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
    469473        $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/overview_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
    470474        $(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml ))
    … …  
    474478                $(VBOX_PATH_MANUAL_OUTBASE)/% : \
    475479                $(VBOX_PATH_MANUAL_SRC)/% \
    476                $$(addprefix $$(@D)/,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
     480               $$(addprefix $$(@D)/user_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
    477481               $$(addprefix $$(@D)/overview_,$$(filter man_VBoxManage%,$$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
    478482                $(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml \
    … …  
    510514        $(QUIET)$(RM) -f [email protected] [email protected]
    511515
    512 
     516##
    513517# Morph man pages into manual sections.
    514 $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/,$(VBOX_MANUAL_XML_REFENTRY_FILES))): \
    515                 $(VBOX_PATH_MANUAL_OUTBASE)/% : $(VBOX_PATH_MANUAL_SRC)/% \
    516                 $(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl \
    517                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
    518                 $(VBOX_VERSION_STAMP) | $$(dir $$@)
    519         $(call MSG_GENERATE,,$@,$<)
    520         $(QUIET)$(RM) -f $@
    521         $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) --xinclude --nonet --output $@ \
    522                 $(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl $<
     518# $(evalcall2 def_vbox_refentry_to_user_sect1)
     519# @param    1   The XSLT source file (relative to Makefile dir).
     520# @param    2   Optional output subdirectory.
     521define def_vbox_refentry_to_user_sect1
     522$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/user_$(2): \
     523                $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
     524                $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl \
     525                $$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
     526                $$(VBOX_VERSION_STAMP) | $$(dir $$@)
     527        $$(call MSG_GENERATE,,$$@,$$<)
     528        $$(QUIET)$$(RM) -f "$$@"
     529        $$(QUIET)$$(VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manual-sect1.xsl $$<
     530endef
     531$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
     532, $(evalcall2 def_vbox_refentry_to_user_sect1,$(lang),$(file))))
    523533
    524534
    … …  
    537547               | $$(dir $$@)
    538548        $(call MSG_GENERATE,,$@,$(filter %.xml,$^))
    539         $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) --xinclude --nonet --output "$@" $< $(filter %.xml,$^)
     549        $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) --output "$@" $< $(filter %.xml,$^)
    540550
    541551$(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml: $(MAKEFILE_CURRENT) | $$(dir $$@)
    … …  
    653663#   pass current language to xsltproc in TARGETLANG variable (extract it from the
    654664#   current directory, should become "de_DE" or the like)
    655         $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) $(XSLTPROC_VERBOSE) --xinclude --nonet --stringparam TARGETLANG $(notdir $(@D)) \
     665        $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG $(notdir $(@D)) \
    656666                -o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
    657667#   for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
    … …  
    682692                $$(VBOX_XML_CATALOG) $$(VBOX_XML_CATALOG_DOCBOOK) $$(MAKEFILE_CURRENT) | $$$$(dir $$$$@)
    683693        $$(call MSG_L1,Validating $$<)
    684         $$(QUIET)$$(VBOX_XMLLINT_WITH_CAT) $$(VBOX_XMLLINT_OPTS) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd \
    685                 --xinclude --noout $$<
     694        $$(QUIET)$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$<
    686695        $$(QUIET)$$(APPEND) -t "$$@" "done"
    687696endef
    … …  
    718727        $(QUIET)$(RM) -f $(addprefix $(@D/),$(VBOX_SDKREF_LATEX_FILES_TARGET))
    719728#       generate TeX source from processed docbook and store it in SDKRef.tex.tmp
    720         $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) $(XSLTPROC_VERBOSE) --xinclude --nonet --stringparam TARGETLANG en_US \
     729        $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) --stringparam TARGETLANG en_US \
    721730                -o [email protected] $(VBOX_PATH_MANUAL_SRC)/docbook2latex.xsl $<
    722731#       for pretty quotes, replace " with `` or '' depending on whether it's at the start of a word;
    … …  
    734743                $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE_CURRENT)
    735744        $(call MSG_L1,Validating $(filter %.xml,$^))
    736         $(QUIET)$(VBOX_XMLLINT_WITH_CAT) $(VBOX_XMLLINT_OPTS) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd \
    737                 --xinclude --noout $(filter %.xml,$^)
     745        $(QUIET)$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd  $(filter %.xml,$^)
    738746
    739747
    … …  
    799807        $(QUIET)$(RM) -f $@
    800808        $(QUIET)$(MKDIR) -p $(@D)
    801         $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) --xinclude --nonet --output $(@D)/ \
     809        $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) --output $(@D)/ \
    802810                --stringparam htmlhelp.chm \
    803811                $(subst /,\\,$(@D)/../VirtualBox.chm) \
    … …  
    865873                | $$(dir $$@)
    866874        $(call MSG_L1,xsltproc $<)
    867         $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) --xinclude --nonet $(XSLTPROC_VERBOSE) \
     875        $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) \
    868876                --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-single/UserManual.html \
    869877                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/docbook-html-one-page-formatcfg.xsl \
    … …  
    878886                | $$(dir $$@)
    879887        $(call MSG_L1,xsltproc $<)
    880         $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) --xinclude --nonet $(XSLTPROC_VERBOSE) \
     888        $(QUIET)$(VBOX_XSLTPROC_WITH_CAT) \
    881889                --output $(VBOX_PATH_MANUAL_OUTBASE)/en_US/html-chunks/index.html \
    882890                --stringparam chunk.section.depth 0 \
    … …  
    935943
    936944#
    937 # VBoxManage man pages.
    938 #
    939 $(evalcall2 def_vbox_replace_paths_in_xslt,docbook-refentry-to-man.xsl,)
    940 
    941 man-experiment: \
    942                 $(VBOX_PATH_MANUAL_SRC)/en_US/man_VBoxManage_extpack.xml \
    943                 $(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-man.xsl \
    944                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK)
    945         $(VBOX_XSLTPROC_WITH_CAT) --xinclude --nonet --output z:/tmp/vboxmanage-extpack.1 \
    946                 $(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-man.xsl \
    947                 $(VBOX_PATH_MANUAL_SRC)/en_US/man_VBoxManage_extpack.xml
    948 
    949 $(evalcall2 def_vbox_replace_paths_in_xslt,docbook-refentry-to-C-help.xsl,)
    950 $(evalcall2 def_vbox_replace_paths_in_xslt,docbook-refentry-to-H-help.xsl,)
    951 
    952 # validate man page XML source
    953 validateman: $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
    954                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE_CURRENT)
    955         $(call MSG_L1,Validating $(filter %.xml,$^))
    956         $(QUIET)$(VBOX_XMLLINT_WITH_CAT) $(VBOX_XMLLINT_OPTS) --dtdvalid $(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd \
    957                 --noout $(filter %.xml,$^)
     945# VBoxManage man pages (parts also required by VBoxManage build-in help).
     946#
     947$(evalcall2 def_vbox_replace_paths_in_xslt,docbook-refentry-to-manpage.xsl,)
     948
     949##
     950# Emits rules for preprocessing refentry sources (applying remarks element),
     951# and for producing the actual man pages.
     952# $(evalcall2 def_vbox_refentry_to_manpage)
     953# @param    1   The language
     954# @param    2   The file name (no path).
     955define def_vbox_refentry_to_manpage
     956$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2): \
     957                $$(VBOX_PATH_MANUAL_SRC)/$(1)/$(2) \
     958                $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl \
     959                $$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
     960                $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
     961        $$(call MSG_GENERATE,,$$@,$$<)
     962        $$(QUIET)$$(RM) -f "$$@"
     963        $$(QUIET)$$(VBOX_XSLTPROC_WITH_CAT) --output $$@ \
     964                $$(VBOX_PATH_MANUAL_SRC)/docbook-refentry-to-manpage-preprocessing.xsl $$<
     965 ifdef VBOX_WITH_XMLLINT
     966        $$(QUIET)$$(VBOX_XMLLINT_WITH_CAT) --dtdvalid $$(VBOX_PATH_DOCBOOK_DTD)/docbookx.dtd $$@
     967 endif
     968
     969$$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(patsubst man_%,%.1,$(basename $(2))): \
     970                $$(VBOX_PATH_MANUAL_OUTBASE)/$(1)/$(2) \
     971                $$(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-manpage.xsl \
     972                $$(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) \
     973                $$(VBOX_VERSION_STAMP) | $$$$(dir $$$$@)
     974        $$(call MSG_GENERATE,,$$@,$$<)
     975        $$(QUIET)$$(RM) -f "$$@"
     976        $$(QUIET)$$(VBOX_XSLTPROC_WITH_CAT) --output $$@ $$(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-manpage.xsl $$<
     977endef
     978$(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
     979, $(evalcall2 def_vbox_refentry_to_manpage,$(lang),$(file))))
     980
     981
     982# Handy aliases.
     983validate-manpages:: $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(VBOX_MANUAL_XML_REFENTRY_FILES))
     984man-experiment:: $(foreach lang,$(VBOX_MANUAL_LANGUAGES),$(foreach file,$(VBOX_MANUAL_XML_REFENTRY_FILES) \
     985                        ,$$(VBOX_PATH_MANUAL_OUTBASE)/$(lang)/$(patsubst man_%,%.1,$(basename $(file)))))
    958986
    959987
    … …  
    9741002        $(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.h
    9751003
     1004$(evalcall2 def_vbox_replace_paths_in_xslt,docbook-refentry-to-C-help.xsl,)
     1005$(evalcall2 def_vbox_replace_paths_in_xslt,docbook-refentry-to-H-help.xsl,)
     1006
    9761007$(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.cpp: \
    9771008                $(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-C-help.xsl \
    978                 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(filter man_VBoxManage_%,$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
    979                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE)
     1009                $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(filter man_VBoxManage-%,$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
     1010                $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE) | $$(dir $$@)
    9801011        $(call MSG_GENERATE,,$@,$<)
    9811012        $(QUIET)$(APPEND) -tn "$@" \
    … …  
    9861017                ''
    9871018        $(foreach refentry,$(filter %.xml,$^) \
    988         ,$(NLTAB)$(QUIET)$(REDIRECT) -a+to "$@" -- $(VBOX_XSLTPROC_WITH_CAT) --xinclude --nonet $< $(refentry))
     1019        ,$(NLTAB)$(QUIET)$(REDIRECT) -a+to "$@" -- $(VBOX_XSLTPROC_WITH_CAT) $< $(refentry))
    9891020        $(QUIET)$(APPEND) -n "$@" \
    9901021        '' \
    9911022                'PCREFENTRY     g_apHelpEntries[] = ' \
    9921023                '{' \
    993                $(foreach refentry,$(filter %.xml,$^), '    &g_$(tolower $(patsubst man_%,%,$(notdir $(basename $(refentry))))), ') \
     1024               $(foreach refentry,$(filter %.xml,$^) \
     1025                , '    &g_$(subst -,_,$(tolower $(patsubst man_%,%,$(notdir $(basename $(refentry)))))), ') \
    9941026                '};' \
    9951027                'const uint32_t g_cHelpEntries = RT_ELEMENTS(g_apHelpEntries);' \
    … …  
    9981030$(VBOX_PATH_MANUAL_OUTBASE)/VBoxManageBuiltInHelp.h: \
    9991031                $(VBOX_PATH_MANUAL_OUTBASE)/docbook-refentry-to-H-help.xsl \
    1000                 $(addprefix $(VBOX_PATH_MANUAL_SRC)/en_US/,$(filter man_VBoxManage_%,$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
    1001                 $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE)
     1032                $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/,$(filter man_VBoxManage-%,$(VBOX_MANUAL_XML_REFENTRY_FILES))) \
     1033                $(VBOX_XML_CATALOG) $(VBOX_XML_CATALOG_DOCBOOK) $(MAKEFILE) | $$(dir $$@)
    10021034        $(call MSG_GENERATE,,$@,$<)
    10031035        $(QUIET)$(APPEND) -tn "$@" \
    … …  
    10151047               '    HELP_CMD_VBOXMANAGE_INVALID = 0,'
    10161048        $(foreach refentry,$(filter %.xml,$^) \
    1017         ,$(NLTAB)$(QUIET)$(REDIRECT) -a+to "$@" -- $(VBOX_XSLTPROC_WITH_CAT) --xinclude --nonet \
     1049        ,$(NLTAB)$(QUIET)$(REDIRECT) -a+to "$@" -- $(VBOX_XSLTPROC_WITH_CAT) \
    10181050                --stringparam 'g_sMode' 'cmd' $< $(refentry))
    10191051        $(QUIET)$(APPEND) -n "$@" \
    … …  
    10211053                '} HELP_CMD_VBOXMANAGE;'
    10221054        $(foreach refentry,$(filter %.xml,$^) \
    1023         ,$(NLTAB)$(QUIET)$(REDIRECT) -a+to "$@" -- $(VBOX_XSLTPROC_WITH_CAT) --xinclude --nonet \
     1055        ,$(NLTAB)$(QUIET)$(REDIRECT) -a+to "$@" -- $(VBOX_XSLTPROC_WITH_CAT) \
    10241056                --stringparam 'g_sMode' 'subcmd' $< $(refentry))
    10251057        $(QUIET)$(APPEND) -n "$@" \

  • trunk/doc/manual/docbook-refentry-to-C-help.xsl

    r56466 r56533  
    165165    <xsl:if test="text()"><xsl:message terminate="yes">cmdsynopsis with text is not supported.</xsl:message></xsl:if>
    166166    <xsl:text>
    167     {   </xsl:text><xsl:call-template name="calc-scope-cmdsynopsis"/><xsl:text>,
     167    {   </xsl:text><xsl:call-template name="calc-scope-cmdsynopsis"/><xsl:text> | REFENTRYSTR_FLAGS_SYNOPSIS,
    168168        "</xsl:text><xsl:call-template name="emit-indentation"/><xsl:apply-templates select="*|@*"/><xsl:text>" },</xsl:text>
    169169  </xsl:template>
    … …  
    171171  <xsl:template match="sbr">
    172172    <xsl:text>" },
    173     {   REFENTRYSTR_SCOPE_SAME,
    174         "    </xsl:text><xsl:call-template name="emit-indentation"/>
     173    {   REFENTRYSTR_SCOPE_SAME | REFENTRYSTR_FLAGS_SYNOPSIS,
     174        "    </xsl:text><xsl:call-template name="emit-indentation"/> <!-- hardcoded in VBoxManageHelp.cpp too -->
     175  </xsl:template>
     176
     177  <xsl:template match="cmdsynopsis/command">
     178    <xsl:text>" },
     179    {   REFENTRYSTR_SCOPE_SAME | REFENTRYSTR_FLAGS_SYNOPSIS,
     180        "</xsl:text><xsl:call-template name="emit-indentation"/>
     181    <xsl:apply-templates select="node()|@*"/>
     182  </xsl:template>
     183
     184  <xsl:template match="cmdsynopsis/command[1]" priority="2">
     185    <xsl:apply-templates select="node()|@*"/>
    175186  </xsl:template>
    176187
    … …  
    234245    <!-- Format the text in the section -->
    235246    <xsl:for-each select="./*[name() != 'title']">
    236       <xsl:choose>
    237         <xsl:when test="self::remark[@scope = 'help-copy-synopsis']">
    238           <xsl:variable name="sSrcId" select="concat('synopsis-', @condition)"/>
    239           <xsl:if test="not(/refentry/refsynopsisdiv/cmdsynopsis[@id = $sSrcId])">
    240             <xsl:message terminate="yes">Could not find any cmdsynopsis with id=<xsl:value-of select="$sSrcId"/> in refsynopsisdiv.</xsl:message>
    241           </xsl:if>
    242           <xsl:apply-templates select="/refentry/refsynopsisdiv/cmdsynopsis[@id = $sSrcId]"/>
    243         </xsl:when>
    244         <xsl:otherwise>
    245           <xsl:apply-templates select="."/>
    246         </xsl:otherwise>
    247       </xsl:choose>
     247      <xsl:apply-templates select="."/>
    248248    </xsl:for-each>
    249249
    … …  
    447447
    448448  <!--
    449     Fail on misplaced scoping remarks.
     449    Execute synopsis copy remark (avoids duplication for complicated xml).
    450450    -->
    451451  <xsl:template match="remark[@role = 'help-copy-synopsis']">
    452     <xsl:choose>
    453       <xsl:when test="parent::refsect2"/>
    454       <xsl:otherwise>
    455         <xsl:message terminate="yes">Misplaced remark/@role=help-copy-synopsis element.
    456 Only supported on: refsect2</xsl:message>
    457       </xsl:otherwise>
    458     </xsl:choose>
     452    <xsl:message terminate="yes">remark/@role=help-copy-synopsis is not supported by this stylesheet. Must preprocess input!</xsl:message>
    459453  </xsl:template>
    460454

  • trunk/doc/manual/en_US/user_VBoxManage.xml

    r56466 r56533  
    45224522  </sect1>
    45234523
    4524   <xi:include href="man_VBoxManage_debugvm.xml" xpointer="element(/1)"
     4524  <xi:include href="user_man_VBoxManage-debugvm.xml" xpointer="element(/1)"
    45254525    xmlns:xi="http://www.w3.org/2001/XInclude" />
    45264526
    4527   <xi:include href="man_VBoxManage_extpack.xml" xpointer="element(/1)"
     4527  <xi:include href="user_man_VBoxManage-extpack.xml" xpointer="element(/1)"
    45284528    xmlns:xi="http://www.w3.org/2001/XInclude" />
    45294529</chapter>

  • trunk/include/VBox/refentry.h

    r56231 r56533  
    4343#define REFENTRY_NBSP               '\b'
    4444
    45 /** @name REFENTRYSTR_SCOPE_XXX - Common string scoping.
     45/** @name REFENTRYSTR_SCOPE_XXX - Common string scoping and flags.
    4646 * @{ */
    47 /** Same scope as previous string table entry. */
     47/** Same scope as previous string table entry, flags are reset and can be
     48 *  ORed in. */
    4849#define REFENTRYSTR_SCOPE_SAME      UINT64_C(0)
    4950/** Global scope. */
    50 #define REFENTRYSTR_SCOPE_GLOBAL    UINT64_MAX
     51#define REFENTRYSTR_SCOPE_GLOBAL    UINT64_C(0x00ffffffffffffff)
     52/** Scope mask. */
     53#define REFENTRYSTR_SCOPE_MASK      UINT64_C(0x00ffffffffffffff)
     54/** Flags mask. */
     55#define REFENTRYSTR_FLAGS_MASK      UINT64_C(0xff00000000000000)
     56/** Command synopsis, special hanging indent rules applies. */
     57#define REFENTRYSTR_FLAGS_SYNOPSIS  RT_BIT_64(63)
    5158/** @} */
    5259

  • trunk/src/VBox/Frontends/VBoxManage/VBoxManageHelp.cpp

    r56479 r56533  
    4444enum HELP_CMD_VBOXMANAGE    g_enmCurCommand = HELP_CMD_VBOXMANAGE_INVALID;
    4545/** The scope maskt for the current subcommand. */
    46 uint64_t                    g_fCurSubcommandScope = UINT64_MAX;
    47 
     46uint64_t                    g_fCurSubcommandScope = REFENTRYSTR_SCOPE_GLOBAL;
     47/** String of spaces that can be used for indentation.   */
     48static const char           g_szSpaces[] = "                                                ";
    4849
    4950/**
    … …  
    5859    Assert(g_enmCurCommand == HELP_CMD_VBOXMANAGE_INVALID);
    5960    g_enmCurCommand       = enmCommand;
    60     g_fCurSubcommandScope = UINT64_MAX;
     61    g_fCurSubcommandScope = REFENTRYSTR_SCOPE_GLOBAL;
    6162}
    6263
    … …  
    104105 * @param   psz             The string table string to print.
    105106 * @param   cchMaxWidth     The maximum output width.
    106  */
    107 static uint32_t printString(PRTSTREAM pStrm, const char *psz, uint32_t cchMaxWidth)
     107 * @param   fFlags          String flags that may affect formatting.
     108 */
     109static uint32_t printString(PRTSTREAM pStrm, const char *psz, uint32_t cchMaxWidth, uint64_t fFlags)
    108110{
    109111    uint32_t    cLinesWritten;
    … …  
    142144        while (*psz == ' ')
    143145            cchIndent++, psz++;
     146        Assert(cchIndent + 4 + 1 <= RT_ELEMENTS(g_szSpaces));
     147
    144148        if (cchIndent + 8 >= cchMaxWidth)
    145149            cchMaxWidth += cchIndent + 8;
    146150
    147151        /* Work our way thru the string, line by line. */
     152        uint32_t cchHangingIndent = 0;
    148153        cLinesWritten = 0;
    149154        do
    150155        {
    151             RTStrmWrite(pStrm, pszIndent, cchIndent);
    152             size_t offLine       = cchIndent;
    153             bool   fPendingSpace = false;
     156            RTStrmWrite(pStrm, g_szSpaces, cchIndent + cchHangingIndent);
     157            size_t   offLine       = cchIndent + cchHangingIndent;
     158            bool     fPendingSpace = false;
    154159            do
    155160            {
    … …  
    183188            RTStrmPutCh(pStrm, '\n');
    184189            cLinesWritten++;
     190
     191            /* Set up hanging indent if relevant. */
     192            if (fFlags & REFENTRYSTR_FLAGS_SYNOPSIS)
     193                cchHangingIndent = 4;
    185194        } while (*psz != '\0');
    186195    }
    … …  
    223232    {
    224233        uint64_t fCurScope = pStrTab->paStrings[i].fScope;
    225         if (fCurScope == REFENTRYSTR_SCOPE_SAME)
    226             fCurScope = fPrevScope;
    227         if (fCurScope & fScope)
     234        if ((fCurScope & REFENTRYSTR_SCOPE_MASK) == REFENTRYSTR_SCOPE_SAME)
     235        {
     236            fCurScope &= ~REFENTRYSTR_SCOPE_MASK;
     237            fCurScope |= (fPrevScope & REFENTRYSTR_SCOPE_MASK);
     238        }
     239        if (fCurScope & REFENTRYSTR_SCOPE_MASK & fScope)
    228240        {
    229241            const char *psz = pStrTab->paStrings[i].psz;
    … …  
    236248                    cLinesWritten++;
    237249                }
    238                 cLinesWritten += printString(pStrm, psz, cchWidth);
     250                cLinesWritten += printString(pStrm, psz, cchWidth, fCurScope & REFENTRYSTR_FLAGS_MASK);
    239251            }
    240252            else
    … …  
    255267 * @returns Number of lines written.
    256268 * @param   enmCommand          The command.
    257  * @param   fSubcommandScope    The subcommand scope, UINT64_MAX for all.
     269 * @param   fSubcommandScope    The subcommand scope, REFENTRYSTR_SCOPE_GLOBAL
     270 *                              for all.
    258271 * @param   pStrm               The output stream.
    259272 */
    … …  
    301314 *
    302315 * @param   enmCommand          The command.
    303  * @param   fSubcommandScope    The subcommand scope, UINT64_MAX for all.
     316 * @param   fSubcommandScope    The subcommand scope, REFENTRYSTR_SCOPE_GLOBAL
     317 *                              for all.
    304318 * @param   pStrm               The output stream.
    305319 */
    … …  
    343357{
    344358    Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
    345     Assert(g_fCurSubcommandScope == UINT64_MAX);
     359    Assert(g_fCurSubcommandScope == REFENTRYSTR_SCOPE_GLOBAL);
    346360
    347361    return errorSyntax("No subcommand specified");
    … …  
    360374{
    361375    Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
    362     Assert(g_fCurSubcommandScope == UINT64_MAX);
     376    Assert(g_fCurSubcommandScope == REFENTRYSTR_SCOPE_GLOBAL);
    363377
    364378    /* check if help was requested. */
    … …  
    387401{
    388402    Assert(g_enmCurCommand != HELP_CMD_VBOXMANAGE_INVALID);
    389     Assert(g_fCurSubcommandScope != UINT64_MAX);
     403    Assert(g_fCurSubcommandScope != REFENTRYSTR_SCOPE_GLOBAL);
    390404
    391405    /* check if help was requested. */
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette