Moved all quoting of docs to print functions.
All checks were successful
Run test asserts / Test-Asserts (push) Successful in 8s

This commit is contained in:
Willem Cazander 2024-07-16 19:32:08 +02:00
parent ff16e6b5cb
commit 760ebffb6f
37 changed files with 410 additions and 409 deletions

View file

@ -1,48 +1,48 @@
MB_OPENMSX_PATH ?=
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_PATH,"Optional path where openMSX binary is located.")
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_PATH,Optional path where openMSX binary is located.)
MB_OPENMSX_BOOT_TIMEOUT ?= 25
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_BOOT_TIMEOUT,"Timeout in seconds to guard for boot failures.")
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_BOOT_TIMEOUT,Timeout in seconds to guard for boot failures.)
MB_OPENMSX_BOOT_OS ?= nextor
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_BOOT_OS,"The default OS to run$$(MB_MAKE_COMMA) valid values are; nextor$$(MB_MAKE_COMMA)msxdos1$$(MB_MAKE_COMMA)msxdos2")
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_BOOT_OS,The default OS to run$$(MB_MAKE_COMMA) valid values are; nextor$$(MB_MAKE_COMMA)msxdos1$$(MB_MAKE_COMMA)msxdos2)
MB_OPENMSX_MACHINE ?= Philips_NMS_8250
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_MACHINE,"The default MSX machine to use.",$(MB_OPENMSX_MACHINE))
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_MACHINE,The default MSX machine to use.)
MB_OPENMSX_MACHINE_RAM ?= ram1mb
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_MACHINE_RAM,"Extra ram extension for machine allowed: off$$(MB_MAKE_COMMA)ram16k$$(MB_MAKE_COMMA)ram64k$$(MB_MAKE_COMMA)ram512k$$(MB_MAKE_COMMA)ram1mb$$(MB_MAKE_COMMA)ram2mb$$(MB_MAKE_COMMA)ram4mb")
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_MACHINE_RAM,Extra ram extension for machine allowed: off$$(MB_MAKE_COMMA)ram16k$$(MB_MAKE_COMMA)ram64k$$(MB_MAKE_COMMA)ram512k$$(MB_MAKE_COMMA)ram1mb$$(MB_MAKE_COMMA)ram2mb$$(MB_MAKE_COMMA)ram4mb)
MB_OPENMSX_SPEED ?= $(if $(findstring turboR,$(MB_OPENMSX_MACHINE)),100,333)
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_SPEED,"The throttled MSX emulation speed.")
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_SPEED,The throttled MSX emulation speed.)
MB_OPENMSX_ARGS ?=
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_ARGS,"Extra arguments to invoke openMSX with.")
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_ARGS,Extra arguments to invoke openMSX with.)
MB_OPENMSX_HDD_SIZE ?= 4m
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_HDD_SIZE,"The default fire-hdd disk image size.")
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_HDD_SIZE,The default fire-hdd disk image size.)
MB_OPENMSX_SCALE_FACTOR ?= 3
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_SCALE_FACTOR,"The gui scale factor to display the emulation.")
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_SCALE_FACTOR,The gui scale factor to display the emulation.)
MB_OPENMSX_THROTTLE ?= off
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_THROTTLE,"An on/off flag to control throttling globally.")
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_THROTTLE,An on/off flag to control throttling globally.)
MB_OPENMSX_HEADLESS ?= on
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_HEADLESS,"Controls if openMSX starts headless.")
$(call mb-make-call,mb-doc-variable,MB_OPENMSX_HEADLESS,Controls if openMSX starts headless.)
MB_OPENMSX_RENDERER ?= SDLGL-PP
$(call mb-make-call,mb-doc-variable-deep,MB_OPENMSX_RENDERER,"The gui renderer used to display the window head with.")
$(call mb-make-call,mb-doc-variable-deep,MB_OPENMSX_RENDERER,The gui renderer used to display the window head with.)
MB_OPENMSX_STDOUT_IGNORE ?= off
$(call mb-make-call,mb-doc-variable-deep,MB_OPENMSX_STDOUT_IGNORE,"Kills logging...rm after issues openMSX are solved.")
$(call mb-make-call,mb-doc-variable-deep,MB_OPENMSX_STDOUT_IGNORE,Kills logging...rm after issues openMSX are solved.)
MB_OPENMSX_STDERR_IGNORE ?= off
$(call mb-make-call,mb-doc-variable-deep,MB_OPENMSX_STDERR_IGNORE,"Kills logging...rm after issues openMSX are solved.")
$(call mb-make-call,mb-doc-variable-deep,MB_OPENMSX_STDERR_IGNORE,Kills logging...rm after issues openMSX are solved.)
MB_OPENMSX_FIRE_PIPE_SMOKE ?=
$(call mb-make-call,mb-doc-variable-flow,MB_OPENMSX_FIRE_PIPE_SMOKE,"Word count of total openMSX executions.")
$(call mb-make-call,mb-doc-variable-flow,MB_OPENMSX_FIRE_PIPE_SMOKE,Word count of total openMSX executions.)
define mb-openmsx-setup
@ -64,7 +64,7 @@ $(MB_   )$(call mb-make-call,mb-msxrom-setup,$(1))
$(MB_   )$(call mb-make-call,mb-msxrom-extension-ide-nextor,$(1))
$(MB_   )$(call mb-make-call,mb-msxrom-machine-$(2),$(1))
endef
$(call mb-make-call,mb-doc-function-deep,mb-openmsx-setup,"Setup openMSX local build home folder for machine.","<dir> <machine>")
$(call mb-make-call,mb-doc-function-deep,mb-openmsx-setup,Setup openMSX local build home folder for machine.,<dir> <machine>)
define _mb-openmsx-path
@ -124,5 +124,5 @@ $(MB_   )$(if $(wildcard $(1)/utils),$(call mb-make-call,_mb-open
$(MB_   )$(if $(wildcard $(1)/command.com),,$(if $(wildcard $(1)/command2.com),,$(call mb-make-call,mb-msxhub-get-$(MB_OPENMSX_BOOT_OS)-boot,$(1))))
$(MB_   )$(call mb-make-call,_mb-openmsx-run,$(1),$(if $(2),$(2),$(MB_OPENMSX_MACHINE)),$(if $(3),$(3),$(MB_OPENMSX_MACHINE_RAM)))
endef
$(call mb-make-call,mb-doc-function,mb-openmsx-dosctl,"Starts openMSX with dos controller.","<dir> [machine] [mem-ext]")
$(call mb-make-call,mb-doc-function,mb-openmsx-dosctl,Starts openMSX with dos controller.,<dir> [machine] [mem-ext])