VirtualBox

Changeset 68352 in vbox


Ignore:
Timestamp:
Aug 9, 2017 1:42:58 PM (7 years ago)
Author:
vboxsync
Message:

manual/Makefile.kmk: cleaned up and addressed the todos, now all manuals are using INSTALLS targets

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/Makefile.kmk

    r68140 r68352  
    11# $Id$
    22## @file
    3 # Sub-Makefile for the VBox User Manual.
     3# Sub-Makefile for the VirtualBox User Manual, SDK reference and other manuals.
    44#
    55
     
    205205if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK))
    206206 if defined(VBOX_ONLY_SDK) || defined(VBOX_WITH_DOCS_SDKREF)
    207   ## @todo make this an install target, drop the BLDDIRS.
    208   OTHERS += \
    209         $(VBOX_PATH_SDK)/docs/SDKRef.pdf
    210   BLDDIRS += \
    211         $(VBOX_PATH_SDK)/docs
     207  INSTALLS += VBox-sdkref-docs
     208  VBox-sdkref-docs_INST = $(INST_SDK)docs/
     209  VBox-sdkref-docs_MODE = a+r,u+w
     210  VBox-sdkref-docs_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
     211  VBox-sdkref-docs_CLEAN = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf
    212212 endif
    213213
    214214 ifdef VBOX_WITH_DOCS_CHM
     215  INSTALLS += VBox-usermanual-chm-docs
     216  VBox-usermanual-chm-docs_INST = $(INST_BIN)
     217  VBox-usermanual-chm-docs_MODE = a+r,u+w
     218  VBox-usermanual-chm-docs_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.chm
     219  VBox-usermanual-chm-docs_CLEAN = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.chm
     220
    215221  VBOX_PATH_BIN_CHM = $(PATH_STAGE_BIN)/VirtualBox.chm
    216222 else  # Do not build chm.
     
    222228                $(PATH_STAGE_BIN)/UserManual.pdf \
    223229                $(VBOX_PATH_BIN_CHM)
    224   OTHERS += \
    225         $(PATH_STAGE_BIN)/UserManual.pdf
    226   OTHERS.win += \
    227         $(VBOX_PATH_BIN_CHM)
    228   OTHERS.linux += \
    229         $(VBOX_PATH_BIN_CHM)
     230  INSTALLS += VBox-usermanual-docs
     231  VBox-usermanual-docs_INST = $(INST_BIN)
     232  VBox-usermanual-docs_MODE = a+r,u+w
     233  VBox-usermanual-docs_SOURCES = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf
     234  VBox-usermanual-docs_CLEAN = $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf
    230235
    231236  ifdef VBOX_WITH_DOCS_TRANSLATIONS
    232    OTHERS += \
    233         $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
     237   INSTALLS += VBox-usermanual-add-docs
     238   VBox-usermanual-add-docs_INST = $(INST_BIN)
     239   VBox-usermanual-add-docs_MODE = a+r,u+w
     240   VBox-usermanual-add-docs_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf=>UserManual_$(f).pdf)
     241   VBox-usermanual-add-docs_CLEAN = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/UserManual.pdf)
     242   VBOX_MANUAL_PACK += \
     243        $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf)
    234244   ifdef VBOX_WITH_DOCS_CHM
    235    OTHERS.win += \
    236         $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
    237    OTHERS.linux += \
    238         $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
     245    INSTALLS += VBox-usermanual-add-chm-docs
     246   VBox-usermanual-add-chm-docs_INST = $(INST_BIN)
     247   VBox-usermanual-add-chm-docs_MODE = a+r,u+w
     248   VBox-usermanual-add-chm-docs_SOURCES = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/VirtualBox.chm=>VirtualBox_$(f).chm)
     249   VBox-usermanual-add-chm-docs_CLEAN = $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$(f)/VirtualBox.chm)
     250    VBOX_MANUAL_PACK += \
     251        $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
    239252   endif
    240253  endif
     
    298311                $(addsuffix /HTMLHelp/images, $(VBOX_MANUAL_LANGUAGES)) \
    299312        )
    300 
    301  ifdef VBOX_WITH_DOCS_CHM
    302  VBOX_MANUAL_PACK += \
    303         $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf $(PATH_STAGE_BIN)/VirtualBox_$(f).chm)
    304  endif
    305313
    306314 OTHER_CLEAN += \
     
    332340               HTMLHelp/htmlhelp.hhp \
    333341                titlepage-htmlhelp.xsl \
    334                 UserManual.pdf \
    335                 VirtualBox.chm \
    336                ChangeLog.html \
    337                validatemanual.run \
     342                ChangeLog.html \
     343                validatemanual.run \
    338344                )) \
    339345        $(VBOX_PATH_MANUAL_OUTBASE)/$(VBOX_MANUAL_XML_CHANGELOG) \
    340346        $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/overview_,$(VBOX_MANUAL_XML_REFENTRY_FILES)) \
    341347        $(VBOX_PATH_MANUAL_OUTBASE)/user_VBoxManage_CommandsOverview.xml \
    342         $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf) \
    343         $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm) \
    344         $(PATH_STAGE_BIN)/UserManual.pdf \
    345         $(PATH_STAGE_BIN)/VirtualBox.chm \
    346348       \
    347349        $(addprefix $(VBOX_PATH_MANUAL_OUTBASE)/en_US/, \
    348350                $(VBOX_SDKREF_XML_FILES) \
    349351                $(VBOX_SDKREF_LATEX_FILES_TARGET) \
    350                 SDKRef.pdf \
    351352                ) \
    352353        $(VBOX_DOC_XIDL_SRC_TMP) \
    353         $(VBOX_MANUAL_APIREF_TMP) \
    354         $(PATH_STAGE_BIN)/sdk/docs/SDKRef.pdf
     354        $(VBOX_MANUAL_APIREF_TMP)
    355355
    356356endif # if defined(VBOX_WITH_DOCS) && (!defined(VBOX_ONLY_BUILD) || defined(VBOX_ONLY_DOCS) || defined(VBOX_ONLY_SDK))
     
    557557##########################################################################################
    558558
    559 ## @todo INSTALLS target for this!
    560 $(PATH_STAGE_BIN)/UserManual.pdf: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/UserManual.pdf | $$(dir $$@)
    561         $(QUIET)$(CP) $< $@
    562         $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
    563 
    564 $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/UserManual_$(f).pdf): \
    565         $(PATH_STAGE_BIN)/UserManual_%.pdf : $(VBOX_PATH_MANUAL_OUTBASE)/%/UserManual.pdf
    566         $(QUIET)$(CP) $< $@
    567         $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
    568 
    569559$(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/UserManual.pdf): \
    570560                $(VBOX_PATH_MANUAL_OUTBASE)/%/UserManual.pdf : \
     
    583573                -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
    584574                $(basename $@).log
    585 
    586 ##@todo restore this when above has been converted to INSTALLS target.  $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
     575        $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
    587576
    588577# generate temporary LaTeX source from processed XML
     
    679668
    680669# Turn SDKRef.tex into a PDF.
    681 $(VBOX_PATH_SDK)/docs/SDKRef.pdf: \
     670$(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.pdf: \
    682671                $(VBOX_PATH_MANUAL_OUTBASE)/en_US/SDKRef.tex \
    683672                $(if $(VBOX_OSE),,$(VBOX_PATH_MANUAL_OUTBASE)/en_US/ucs.sty) \
     
    692681                -e '/Warning: There were \(undefined references\|multiply-defined labels\)/{p; q 1}' \
    693682                $(basename $<).log
    694         $(QUIET)$(CP) $(<D)/SDKRef.pdf $@
    695683        $(call MSG_L1,Fresh LaTeX-generated PDF is now at $@)
    696684
     
    716704        $(VBOX_PATH_MANUAL_SRC)/common-html-formatcfg.xsl
    717705
    718  $(PATH_STAGE_BIN)/VirtualBox.chm: $(VBOX_PATH_MANUAL_OUTBASE)/en_US/VirtualBox.chm
    719         $(QUIET)$(CP) $< $@
    720         $(call MSG_L1,Fresh CHM is now at $@)
    721 
    722  $(foreach f,$(VBOX_MANUAL_ADD_LANGUAGES),$(PATH_STAGE_BIN)/VirtualBox_$(f).chm): \
    723         $(PATH_STAGE_BIN)/VirtualBox_%.chm : $(VBOX_PATH_MANUAL_OUTBASE)/%/VirtualBox.chm
    724         $(QUIET)$(CP) $< $@
    725         $(call MSG_L1,Fresh CHM is now at $@)
    726 
    727706 $(foreach f,$(VBOX_MANUAL_LANGUAGES),$(VBOX_PATH_MANUAL_OUTBASE)/$f/VirtualBox.chm): \
    728707                $(VBOX_PATH_MANUAL_OUTBASE)/%/VirtualBox.chm: \
     
    732711        $(QUIET)$(RM) -f $@
    733712        $(QUIET)$(VBOX_HHC) $(subst /,\\,$<)
     713        $(call MSG_L1,Fresh CHM is now at $@)
    734714
    735715 # Prepare the XSL file for our title page, htmlhelp variant.
Note: See TracChangeset for help on using the changeset viewer.

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