Changeset 99058 in vbox for trunk/doc/manual

Timestamp:

Mar 20, 2023 2:01:52 AM (2 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

156423

Message:

manual/Makefile.kmk: Cleaning up the makefile step by step... bugref:10348 bugref:10302

File:

• trunk/doc/manual/Makefile.kmk (modified) (6 diffs)

trunk/doc/manual/Makefile.kmk

@@ -603 +603 @@
 
  #
- # We copy/hardlink all the files under <lang>/dita/* to the corresponding
- # VBOX_PATH_MANUAL_OUTBASE location.  This is mainly to deal with DITO-OT's
- # inability to search for topic files in more than one place, so we have to
- # gather generated and static topic sources + the .ditamap-file(s) in one
- # place.
+ # 1. We copy/hardlink all the files under <lang>/dita/* to the corresponding
+ #    VBOX_PATH_MANUAL_OUTBASE location.  This is mainly to deal with DITO-OT's
+ #    inability to search for topic files in more than one place, so we have to
+ #    gather generated and static topic sources + the .ditamap-file(s) in one
+ #    place.
  #
 
@@ -616 +616 @@
  VBOX_USER_MANUAL_DITA_BASIC_SRC_FILES := \
         $(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/*.ditamap)) \
-        $(addprefix topics/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*dita))) \
-        $(addprefix topics/images/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/images/*png)))
+        $(addprefix topics/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/*dita))) \
+        $(addprefix topics/images/,$(notdir $(wildcard $(VBOX_PATH_MANUAL_SRC)/en_US/dita/topics/images/*png)))
 
  ##
@@ -627 +627 @@
  define def_vbox_copy_manual_dita_src_files
   VBOX_USER_MANUAL_DITA_SRC_FILES_$(1) := \
-        $$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/*.ditamap)) \
-        $$(addprefix topics/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/*dita))) \
-        $$(addprefix topics/images/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/images/*png)))
+        $$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/*.ditamap)) \
+        $$(addprefix topics/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/*dita))) \
+        $$(addprefix topics/images/,$$(notdir $$(wildcard $$(VBOX_PATH_MANUAL_SRC)/$1/dita/topics/images/*png)))
   VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK := \
         $$(filter-out $$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)), $$(VBOX_USER_MANUAL_DITA_BASIC_SRC_FILES))
 
   VBOX_USER_MANUAL_DITA_STAGED_FILES_$(1) = \
-        $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/,\
-                $$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)) \
-                $$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK) \
-                topics/reference.dtd)
+        $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/, \
+        $$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)) \
+        $$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK) \
+        topics/reference.dtd)
 
   ifneq ($$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)),)
    $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/,$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1))): \
-         $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/%: \
-                 $$(VBOX_PATH_MANUAL_SRC)/$1/dita/% | $$$$(dir $$$$@)
+                $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/% : \
+                $$(VBOX_PATH_MANUAL_SRC)/$1/dita/% | $$$$(dir $$$$@)
         $$(QUIET)$$(INSTALL_STAGING) -m 0644 -- "$$<" "$$(@D)/"
   endif
@@ -648 +648 @@
   ifneq ($$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK),)
    $$(addprefix $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/,$$(VBOX_USER_MANUAL_DITA_SRC_FILES_$(1)_FALLBACK)): \
-         $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/%: \
-         $$(VBOX_PATH_MANUAL_SRC)/en_US/dita/% | $$$$(dir $$$$@)
+                $$(VBOX_PATH_MANUAL_OUTBASE)/$1/dita/% : \
+                $$(VBOX_PATH_MANUAL_SRC)/en_US/dita/% | $$$$(dir $$$$@)
         $$(QUIET)$$(INSTALL_STAGING) -m 0644 -- "$$<" "$$(@D)/"
   endif
@@ -672 +672 @@
         $(call MSG_L1, Ran common dita steps)
         $(QUIET)$(TOUCH) -- "$@"
+
+
+ #
+ # 2. Convert the manpages from Docbook refentry files to DITA reference files.
+ #
+ #    In DITA links needs proper href values, with both file and ID.  Since the
+ #    source only has IDs, we scan all topics and refentry-files alike and
+ #    generate a mapping database before we start converting them.  This DB is
+ #    then used at the end of each conversion to fix the hrefs.
+ #
 
 
@@ -811 +821 @@
                 $$(VBOX_MANUAL_XML_FILES_COMMON) \
                 $$(VBOX_MANUAL_XML_FILES_GENERATED_$(lang)) \
-                $$(VBOX_USER_MANUAL_DITA_STAGED_FILES_$(lang)) \
+                $$(VBOX_USER_MANUAL_DITA_STAGED_FILES_$(lang)) \
                 $$(VBOX_PATH_MANUAL_OUTBASE)/dita_common
         $$(QUIET)$(RM) -f -- "$$@"