arch-msx/msxbuild
2
0
Fork 0
Code Issues Pull requests 3 Activity Actions

Moved doc out of shell and made include 18 bit to remove binary.
All checks were successful
Run test asserts / Test-Asserts (push) Successful in 6s
Details

Browse source
This commit is contained in:
Willem Cazander 2024-07-17 12:46:31 +02:00
parent ba2cc20af4
commit 4e27098c3b
5 changed files with 100 additions and 116 deletions
Download patch file Download diff file Expand all files Collapse all files

130
lib/make/𓃬𓍄𓋹𓀭/mb_flow_help.mk
View file

@ -1,88 +1,86 @@
MB_FLOW_HELP_TEMP := $(shell mktemp)
$(call mb-make-call,mb-doc-variable-rock,MB_FLOW_HELP_TEMP,Temp file to output help with.)
# Never use echo to display real text: Argument List Too Long
define _mb-flow-print-help
$(MB_ᕽᕽᕽ　　　)@echo -e "$(2)"
$(MB_ᕽᕽᕽ　　　)$(file >$(MB_FLOW_HELP_TEMP),$($(1)))
$(MB_ᕽᕽᕽ　　　)@cat $(MB_FLOW_HELP_TEMP) | sed 's/\\n/\n/g' | sed 's/\\t/\t/g'
$(MB_ᕽᕽᕽ　　　)$(call mb-make-call,mb-os-file-delete,$(MB_FLOW_HELP_TEMP))
endef
define __mb-flow-doc-help
.RECIPEPREFIX := $(MB_@RECIPE)
@help:
$(MB_@RECIPE)@echo -e "Welcome to the $$(if $$(MB_PROJ_META_NAME),$$(MB_PROJ_META_NAME),MSXBUILD) help system.\\n\\nFor detailed fire help use one of the following targets;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET_HELP)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_TARGET_HELP,Welcome to the $$(if $$(MB_PROJ_META_NAME),$$(MB_PROJ_META_NAME),MSXBUILD) help system.\\n\\nFor detailed fire help use one of the following targets;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help)
@help-variable:
$(MB_@RECIPE)@echo -e "Documention of the make fire variables;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_VARIABLE,Documention of the make fire variables;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-variable,Lists build variables.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-variable)
@help-variable-deep:
$(MB_@RECIPE)@echo "Documention of the deep make variables;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE_DEEP)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_VARIABLE_DEEP,Documention of the deep make variables;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-variable-deep,Lists deep variables.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-variable-deep)
@help-variable-rock:
$(MB_@RECIPE)@echo -e "Documention of the rock make variables;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE_ROCK)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_VARIABLE_ROCK,Documention of the rock make variables;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-variable-rock,Lists rock variables.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-variable-rock)
@help-variable-flow:
$(MB_@RECIPE)@echo -e "Documention of the flow make variables;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE_FLOW)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_VARIABLE_FLOW,Documention of the flow make variables;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-variable-flow,Lists flow variables.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-variable-flow)
@help-variable-i18n:
$(MB_@RECIPE)@echo -e "Documention of the i18n make variables;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE_I18N)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_VARIABLE_I18N,Documention of the i18n make variables;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-variable-i18n,Lists i18n variables.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-variable-i18n)
@help-function:
$(MB_@RECIPE)@echo -e "Documention of the make fire functions;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_FUNCTION)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_FUNCTION,Documention of the make fire functions;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-function,Lists build functions.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-function)
@help-function-deep:
$(MB_@RECIPE)@echo -e "Documention of the deep make functions;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_FUNCTION_DEEP)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_FUNCTION_DEEP,Documention of the deep make functions;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-function-deep,Lists deep functions.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-function-deep)
@help-function-flow:
$(MB_@RECIPE)@echo -e "Documention of the flow make functions;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_FUNCTION_FLOW)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_FUNCTION_FLOW,Documention of the flow make functions;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-function-flow,Lists flow functions.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-function-flow)
@help-target:
$(MB_@RECIPE)@echo -e "Build one of the following make fire targets;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_TARGET,Build one of the following make fire targets;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-target,Lists build targets.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-target)
@help-target-deep:
$(MB_@RECIPE)@echo -e "Build one of the following deep make targets;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET_DEEP)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_TARGET_DEEP,Build one of the following deep make targets;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-target-deep,Lists deep targets.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-target-deep)
@help-target-run:
$(MB_@RECIPE)@echo -e "Build one of the following run make targets;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET_RUN)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_TARGET_RUN,Build one of the following run make targets;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-target-run,Lists runnable targets.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-target-run)
@help-target-module:
$(MB_@RECIPE)@echo -e "Build one of the following module make targets;"
$(MB_@RECIPE)$$(file >bin/@help.txt,$$(MB_DOC_FIRE_TARGET_MODULE))
$(MB_@RECIPE)@cat bin/@help.txt | sed 's/\\\\n/\n/g' | sed 's/\\\\t/\t/g' | sed 's/\"//g'
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_TARGET_MODULE,Build one of the following module make targets;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-target-module,Lists module targets.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-target-module)
@help-target-assert:
$(MB_@RECIPE)@echo -e "Build one of the following assert make targets;"
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET_ASSERT)
$(MB_@RECIPE)$$(call mb-make-call,_mb-flow-print-help,MB_DOC_FIRE_TARGET_ASSERT,Build one of the following assert make targets;)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-target-assert,Lists assert targets.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-target-assert)
@ -92,63 +90,41 @@ $(MB_@RECIPE)@echo -e "\n "$(foreach _rom,$(MB_MSXROM_FIRE_MACHINES)," * $(_rom)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-machine,Lists supported machines.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-machine)
@help-all:
$(MB_@RECIPE)@echo -e "Documention of all fire functions/variables/targets;\\n"
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Variables)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE)
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Variables in the deep)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE_DEEP)
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Variables hard as rock)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE_ROCK)
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Variables defining flow)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE_FLOW)
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Variables for i18n letters)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE_I18N)
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Functions)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_FUNCTION)
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Functions in the deep)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_FUNCTION_DEEP)
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Functions building flow)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_FUNCTION_FLOW)
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Targets)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET)
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Targets in the deep)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET_DEEP)
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Targets that run away)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET_RUN)
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Targets from modules builds)
$(MB_@RECIPE)$$(file >bin/@help.txt,$$(MB_DOC_FIRE_TARGET_MODULE))
$(MB_@RECIPE)@cat bin/@help.txt | sed 's/\\\\n/\n/g' | sed 's/\\\\t/\t/g' | sed 's/\"//g'
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Targets that assert hopefully)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET_ASSERT)
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,Targets main project help)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET_HELP)
@help-all: \
$(MB_ᕽᕽᕽ　　　)@help-variable @help-variable-deep @help-variable-rock @help-variable-flow @help-variable-i18n \
$(MB_ᕽᕽᕽ　　　)@help-function @help-function-deep @help-function-flow \
$(MB_ᕽᕽᕽ　　　)@help-target @help-target-deep @help-target-run @help-target-module @help-target-assert \
$(MB_ᕽᕽᕽ　　　)@help-machine
$(MB_@RECIPE)$$(call mb-make-call,mb-os-echo-good,OK)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-all,Lists all documented information.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-all)
@help-firemake:
$(MB_@RECIPE)$$(eval MB_DOC_FORMAT :$(MB_MAKE_EQUALS) xml)
$(MB_@RECIPE)@echo -e $$(call mb-make-call,mb-make-xml-open,$$(MB_DOC_XML_ROOT))
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE_DEEP)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE_ROCK)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE_FLOW)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_VARIABLE_I18N)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_FUNCTION)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_FUNCTION_DEEP)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_FUNCTION_FLOW)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET_DEEP)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET_RUN)
$(MB_@RECIPE)$$(file >bin/@help.txt,$$(MB_DOC_FIRE_TARGET_MODULE))
$(MB_@RECIPE)@cat bin/@help.txt | sed 's/\\\\n/\n/g' | sed 's/\\\\t/\t/g' | sed 's/\\\"/__TMP/g' | sed 's/\"//g' | sed 's/__TMP/\"/g'
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET_ASSERT)
$(MB_@RECIPE)@echo -e $$(MB_DOC_FIRE_TARGET_HELP)
$(MB_@RECIPE)@echo -e $$(call mb-make-call,mb-make-xml-close,$$(MB_DOC_XML_ROOT))
$(MB_@RECIPE)$$(file >$(MB_FLOW_HELP_TEMP),$$(call mb-make-call,mb-make-xml-open,$$(MB_DOC_XML_ROOT)))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_VARIABLE))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_VARIABLE_DEEP))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_VARIABLE_ROCK))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_VARIABLE_FLOW))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_VARIABLE_I18N))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_FUNCTION))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_FUNCTION_DEEP))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_FUNCTION_FLOW))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_TARGET))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_TARGET_DEEP))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_TARGET_RUN))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_TARGET_MODULE))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_TARGET_ASSERT))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(MB_DOC_FIRE_TARGET_HELP))
$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(call mb-make-call,mb-make-xml-close,$$(MB_DOC_XML_ROOT)))
$(MB_@RECIPE)@cat $$(MB_FLOW_HELP_TEMP) | sed 's/\\n/\n/g' | sed 's/\\t/\t/g' | sed 's/\\"/\"/g'
$(MB_@RECIPE)$$(call mb-make-call,mb-os-file-delete,$$(MB_FLOW_HELP_TEMP))
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-doc-target-help,@help-firemake,Output all documention in XML for IDE integration.)
$(MB_ᕽᕽᕽ　　　)$$(call mb-make-call,mb-make-target-phony,@help-firemake)
# TODO: create doc for "warpue" xml tag + list Word vAriable Readout Private valUE (for UI)
#$(MB_@RECIPE)$$(file >>$(MB_FLOW_HELP_TEMP),$$(foreach _rom,$$(MB_MSXROM_FIRE_MACHINES),\t$$(call mb-make-call,mb-make-xml-open,$$(MB_DOC_XML_TAG_MACHINE),name,$$(_rom))$$(call mb-make-call,mb-make-xml-close,$$(MB_DOC_XML_TAG_MACHINE))\n))
.RECIPEPREFIX := $(MB_@RECIPEPREFIX)
endef
define mb-flow-doc-help