Allow the title of top level pages to be overridden in the Atmel Studio help.

[pub/USBasp.git] / LUFA / StudioIntegration / makefile

diff --git a/LUFA/StudioIntegration/makefile b/LUFA/StudioIntegration/makefile
index 55efdcd..471ab6d 100644 (file)
--- a/LUFA/StudioIntegration/makefile
+++ b/LUFA/StudioIntegration/makefile
@@ -10,26 +10,61 @@
 # ---------------------------------------
 
 LUFA_ROOT            := ..
 # ---------------------------------------
 
 LUFA_ROOT            := ..

+LUFA_VERSION_NUM     := $(shell grep LUFA_VERSION_STRING $(LUFA_ROOT)/Version.h | cut -d'"' -f2)
+
+ifneq ($(LUFA_VERSION_NUM),000000)
+  EXT_VERSION_NUM    := $(shell date +"%y.%m.%d").$(LUFA_VERSION_NUM)
+  EXT_VSIX_NAME      := LUFA-RELEASE-$(LUFA_VERSION_NUM).vsix
+else
+  EXT_VERSION_NUM    := 0.$(shell date +"%y%m%d.%H%M%S")
+  EXT_VSIX_NAME      := LUFA-TESTING-$(shell date +"%y.%m.%d-%H.%M.%S").vsix
+
+  $(warning No LUFA version set - assuming a test version should be created.)
+endif
+

 DOXYGEN_TAG_FILE_XML := $(LUFA_ROOT)/Documentation/lufa_doc_tags.xml
 DOXYGEN_TAG_FILE_XML := $(LUFA_ROOT)/Documentation/lufa_doc_tags.xml

+DOXYGEN_COMBINED_XML := $(LUFA_ROOT)/Documentation/xml/lufa_doc.xml

 TEMP_MANIFEST_XML    := manifest.xml
 EXTENSION_OUTPUT_XML := $(LUFA_ROOT)/../extension.xml
 MODULE_OUTPUT_XML    := $(LUFA_ROOT)/asf.xml
 TEMP_MANIFEST_XML    := manifest.xml
 EXTENSION_OUTPUT_XML := $(LUFA_ROOT)/../extension.xml
 MODULE_OUTPUT_XML    := $(LUFA_ROOT)/asf.xml

+MSHELP_OUTPUT_XML    := $(LUFA_ROOT)/../lufa_help_$(EXT_VERSION_NUM).mshc

 XML_FILES            := $(filter-out $(TEMP_MANIFEST_FILE), $(shell ls *.xml))
 XML_FILES            := $(filter-out $(TEMP_MANIFEST_FILE), $(shell ls *.xml))

-LUFA_VERSION_NUM     := $(shell grep LUFA_VERSION_STRING $(LUFA_ROOT)/Version.h | cut -d'"' -f2)
-EXT_VERSION_NUM      := $(shell date +"%y.%m.%d").$(LUFA_VERSION_NUM)
+VSIX_ASSETS          := $(LUFA_ROOT)/DoxygenPages/Images/LUFA_thumb.png \
+                        $(LUFA_ROOT)/DoxygenPages/Images/LUFA.png       \
+                        $(LUFA_ROOT)/License.txt                        \
+                        VSIX/"[Content_Types].xml"                      \
+                        VSIX/ASFExplorer.png                            \
+                        VSIX/ASFWizard.png                              \
+                        VSIX/NewExampleWizard.png                       \
+                        VSIX/GettingStarted.htm                         \
+                        Blob/Atmel.Studio.Services.Interfaces.dll       \
+                        Blob/LUFA.dll                                   \
+                        Blob/LUFA.pkgdef                                \
+
+MSHELP_GEN_PARAMS   := --stringparam generate.toc "book toc"            \
+                       --stringparam chunk.quietly "1"                  \
+                       --stringparam chunk.section.depth "3"            \
+                       --stringparam chunk.first.sections "1"           \
+                       --stringparam chapter.autolabel "0"              \
+                       --stringparam html.stylesheet "lufa_studio_help_styling.css"

 
 all: generate_xml check_filenames generate_vsix
 
 clean:
 
 all: generate_xml check_filenames generate_vsix
 
 clean:

-       @rm $(TEMP_MANIFEST_XML) $(MODULE_OUTPUT_XML) $(EXTENSION_OUTPUT_XML)
+       @rm -f $(TEMP_MANIFEST_XML) $(MODULE_OUTPUT_XML) $(EXTENSION_OUTPUT_XML) $(DOXYGEN_TAG_FILE_XML) $(DOXYGEN_COMBINED_XML) $(MSHELP_OUTPUT_XML)
+       @rm -rf mshelp
+       @cd $(LUFA_ROOT)/.. && rm -f contents.zip exampleProjects.xml content.xml.cache extension.vsixmanifest asf-manifest.xml extension.xml helpcontentsetup.msha $(notdir $(VSIX_ASSETS)) *.vsix *.mshc

 
 $(DOXYGEN_TAG_FILE_XML):
 
 $(DOXYGEN_TAG_FILE_XML):

-       make -C ../ doxygen
+       @$(MAKE) -C ../ doxygen DOXYGEN_OVERRIDE_PARAMS="GENERATE_TAGFILE=Documentation/lufa_doc_tags.xml GENERATE_HTML=no GENERATE_XML=yes"
+
+$(DOXYGEN_COMBINED_XML): $(DOXYGEN_TAG_FILE_XML)
+       @xsltproc $(dir $@)/combine.xslt $(dir $@)/index.xml > $(DOXYGEN_COMBINED_XML)

 
 

-$(TEMP_MANIFEST_XML): $(DOXYGEN_TAG_FILE_XML)
+$(TEMP_MANIFEST_XML): $(DOXYGEN_TAG_FILE_XML) $(DOXYGEN_COMBINED_XML)

        @echo "Generating Manifest XML..."
 
        @echo "Generating Manifest XML..."
 

-       @printf "<lufa-manifest version=\"%s\" tagfile=\"%s\">\n" $(LUFA_VERSION_NUM) $(DOXYGEN_TAG_FILE_XML) > $@
+       @printf "<lufa-manifest version=\"%s\" tagfile=\"%s\" docfile=\"%s\">\n" $(LUFA_VERSION_NUM) $(DOXYGEN_TAG_FILE_XML) $(DOXYGEN_COMBINED_XML) > $@

        @for i in $(XML_FILES); do \
                printf "\t<xml-source filename=\"%s\"/>\n" $$i >> $@; \
        done;
        @for i in $(XML_FILES); do \
                printf "\t<xml-source filename=\"%s\"/>\n" $$i >> $@; \
        done;


@@ -37,43 +72,62 @@ $(TEMP_MANIFEST_XML): $(DOXYGEN_TAG_FILE_XML)
 
        @echo "Manifest XML file generated."
 
 
        @echo "Manifest XML file generated."
 

-generate_xml: $(TEMP_MANIFEST_XML)
+$(MODULE_OUTPUT_XML): $(TEMP_MANIFEST_XML)

        @echo "Processing asf.xml file..."
        @echo "Processing asf.xml file..."

-       @xsltproc XSLT/lufa_module_transform.xslt $< | xsltproc XSLT/lufa_indent_transform.xslt - > $(MODULE_OUTPUT_XML)
+       @xsltproc XDK/lufa_module_transform.xslt $< | xsltproc XDK/lufa_indent_transform.xslt - > $(MODULE_OUTPUT_XML)

        @echo "Atmel Studio asf.xml file generated."
 
        @echo "Atmel Studio asf.xml file generated."
 

+$(EXTENSION_OUTPUT_XML): $(TEMP_MANIFEST_XML)

        @echo "Processing extension.xml file..."
        @echo "Processing extension.xml file..."

-       @xsltproc XSLT/lufa_extension_transform.xslt $< | xsltproc XSLT/lufa_indent_transform.xslt - > $(EXTENSION_OUTPUT_XML)
+       @xsltproc XDK/lufa_extension_transform.xslt $< | xsltproc XDK/lufa_indent_transform.xslt - > $(EXTENSION_OUTPUT_XML)

        @echo "Atmel Studio extension.xml file generated."
 
        @echo "Atmel Studio extension.xml file generated."
 

-       @rm $(TEMP_MANIFEST_XML)
+$(MSHELP_OUTPUT_XML): $(DOXYGEN_COMBINED_XML)
+       @echo Converting Doxygen XML to Docbook...
+       @-mkdir mshelp 2> /dev/null
+       @xsltproc HV1/lufa_docbook_transform.xslt $(DOXYGEN_COMBINED_XML) > mshelp/lufa_docbook.xml

 
 

-generate_vsix: $(EXTENSION_OUTPUT_XML) $(MODULE_OUTPUT_XML)
+       @echo Converting Docbook XML to Microsoft Help 1.0...
+       @cd mshelp && xsltproc $(MSHELP_GEN_PARAMS) ../HV1/lufa_hv1_transform.xslt lufa_docbook.xml
+
+       @echo Copying help assets...
+       @cp HV1/lufa_studio_help_styling.css mshelp
+       @-mkdir mshelp/images 2> /dev/null
+       @cp `find $(LUFA_ROOT)/DoxygenPages/Images -type f` mshelp/images
+
+       @echo Archiving help content...
+       @cd mshelp && zip ../$(MSHELP_OUTPUT_XML) -q -0  -r *.html *.css images
+
+
+generate_xml: $(EXTENSION_OUTPUT_XML) $(MODULE_OUTPUT_XML)
+
+generate_vsix: $(EXTENSION_OUTPUT_XML) $(MODULE_OUTPUT_XML) $(MSHELP_OUTPUT_XML)

        @echo "Generating ASF cache files..."
        @rm -f $(LUFA_ROOT)/../content.xml.cache
        @rm -f $(LUFA_ROOT)/../ExampleProjects.xml
        @echo "Generating ASF cache files..."
        @rm -f $(LUFA_ROOT)/../content.xml.cache
        @rm -f $(LUFA_ROOT)/../ExampleProjects.xml

-       @python generate_caches.py $(LUFA_ROOT)/../
+       @python VSIX/generate_caches.py $(LUFA_ROOT)/../

 
 

-       @echo "Archiving Content..."
-       @cd $(LUFA_ROOT)/../ && zip contents.zip -q -9 -r --exclude=*Documentation* --exclude=*StudioIntegration* LUFA Bootloaders Demos Projects extension.xml README.txt
+       @echo "Archiving ASF content..."
+       @rm -f contents.zip
+       @cd $(LUFA_ROOT)/../ && zip contents.zip -q -0 -r --exclude=*Documentation* --exclude=*StudioIntegration* LUFA Bootloaders Demos Projects README.txt

 
 

-       @echo "Creating VSIX Dependencies..."
-       @cp $(LUFA_ROOT)/DoxygenPages/Images/LUFA_thumb.png $(LUFA_ROOT)/../PreviewThumb.png
-       @cp $(LUFA_ROOT)/DoxygenPages/Images/LUFA.png $(LUFA_ROOT)/../Preview.png
-       @cp $(LUFA_ROOT)/License.txt $(LUFA_ROOT)/../
-       @cp "VSIX/[Content_Types].xml" $(LUFA_ROOT)/../
-       @xsltproc --stringparam extension-version "$(EXT_VERSION_NUM)" XSLT/lufa_vsmanifest_transform.xslt VSIX/extension.vsixmanifest > $(LUFA_ROOT)/../extension.vsixmanifest
-       @xsltproc --stringparam lufa-version "$(LUFA_VERSION_NUM)" XSLT/lufa_asfmanifest_transform.xslt VSIX/asf-manifest.xml > $(LUFA_ROOT)/../asf-manifest.xml
+       @echo "Creating VSIX dependencies..."
+       @cp $(VSIX_ASSETS) $(LUFA_ROOT)/..
+       @xsltproc --stringparam extension-version "$(EXT_VERSION_NUM)" VSIX/lufa_vsmanifest_transform.xslt VSIX/extension.vsixmanifest > $(LUFA_ROOT)/../extension.vsixmanifest
+       @xsltproc --stringparam lufa-version "$(LUFA_VERSION_NUM)" VSIX/lufa_asfmanifest_transform.xslt VSIX/asf-manifest.xml > $(LUFA_ROOT)/../asf-manifest.xml
+       @xsltproc --stringparam extension-version "$(EXT_VERSION_NUM)" HV1/lufa_helpcontentsetup_transform.xslt HV1/helpcontentsetup.msha > $(LUFA_ROOT)/../helpcontentsetup.msha

 
 

-       @echo "Generating Atmel Studio VSIX Extension file..."
-       @cd $(LUFA_ROOT)/../ && zip LUFA.vsix -q contents.zip exampleProjects.xml content.xml.cache License.txt Preview.png PreviewThumb.png "[Content_Types].xml" extension.vsixmanifest asf-manifest.xml extension.xml
+       @echo "Generating Atmel Studio VSIX file..."
+       cd $(LUFA_ROOT)/../ && zip $(EXT_VSIX_NAME) -q -9 contents.zip exampleProjects.xml content.xml.cache extension.vsixmanifest asf-manifest.xml extension.xml helpcontentsetup.msha $(notdir $(MSHELP_OUTPUT_XML)) $(notdir $(VSIX_ASSETS))

        @echo "Atmel Studio VSIX Extension file generated."
 
 check_filenames: $(MODULE_OUTPUT_XML)
        @echo Verifying referenced filenames of ASF.xml modules...
        @for f in `find $(LUFA_ROOT)/../ -name "asf.xml"`; do \
        @echo "Atmel Studio VSIX Extension file generated."
 
 check_filenames: $(MODULE_OUTPUT_XML)
        @echo Verifying referenced filenames of ASF.xml modules...
        @for f in `find $(LUFA_ROOT)/../ -name "asf.xml"`; do \

-               xsltproc XSLT/lufa_filelist_transform.xslt $$f | grep -v "^<" | sed -e "/^$$/d" | while read -r i; do \
-                       if ( ! test -f "`dirname $$f`/$$i" ); then \
+               echo "Checking $$f..."; \
+               asf_file_dir=`dirname $$f`; \
+               xsltproc XDK/lufa_filelist_transform.xslt $$f | sed -e "/^$$/d" | while read -r i; do \
+                       if ( ! test -f "$$asf_file_dir/$$i" ); then \

                                echo "Source file \"$$i\" referenced in $$f does not exist!"; \
                                exit 1; \
                        fi; \
                                echo "Source file \"$$i\" referenced in $$f does not exist!"; \
                                exit 1; \
                        fi; \


@@ -81,4 +135,7 @@ check_filenames: $(MODULE_OUTPUT_XML)
        done;
        @echo Verified referenced filenames of ASF.xml modules.
 
        done;
        @echo Verified referenced filenames of ASF.xml modules.
 

-.PHONY: all clean generate_xml generate_vsix check_filenames
+sanity_check:
+       python ProjectGenerator/project_generator.py -b $(LUFA_ROOT)/../ --main-ext-uuid=0e160d5c-e331-48d9-850b-e0387912171b CHECK
+
+.PHONY: all clean generate_xml generate_vsix check_filenames sanity_check