From 8760a8dd9862219e063a68b3a5fd490f81b35566 Mon Sep 17 00:00:00 2001 From: Willem Date: Fri, 5 Jul 2024 21:20:14 +0200 Subject: [PATCH] Updated help mojo. --- README.md | 73 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 37 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 2fa9720..3a2ad2c 100644 --- a/README.md +++ b/README.md @@ -44,39 +44,40 @@ TODO Running: `make` - Use 'make help' for possible targets and documention. - -Running: `make help` - Welcome to the MSXBUILD help system. - For detailed help use one of the following targets; + For detailed fire help use one of the following targets; - * help@target - * help@function - * help@variable - + * @help-variable + Lists build variables. + + * @help-variable-deep + Lists deep variables. + + * @help-variable-rock + Lists rock variables. + + * @help-variable-flow + Lists flow variables. + + * @help-function + Lists build functions. + + * @help-function-deep + Lists deep functions. + + * @help-function-flow + Lists flow functions. + + * @help-target + Lists build targets. + + * @help-target-deep + Lists deep targets. + + * @help-all + Lists all documented information. -Running: `make help@function` - - Documention of the make functions; - - * mb_doc_function [desc] [args] - Prints formatted documention of an function. - - * mb_doc_variable [desc] [value] - Prints formatted documention of an variable. - - * mb_doc_target [desc] - Prints formatted documention of an target. - - * mb_doc_project - Prints formatted documention of an project (help). - - * mb_doc_show_help@all - Displays text for 'make' - - ... ## Example Project @@ -87,23 +88,23 @@ When you want to see whats happening do a debug run; real 0m3.223s debug run at 11 Mhz; - time MB_OPENMSX_HEADLESS=off MB_OPENMSX_THROTTLE=on make bin/@assert-all + time VERBOSE=on MB_OPENMSX_HEADLESS=off MB_OPENMSX_THROTTLE=on make bin/@assert-all real 1m4.856s debug run real msx speed; - time MB_OPENMSX_HEADLESS=off MB_OPENMSX_THROTTLE=on MB_OPENMSX_SPEED=100 make bin/@assert-all + time VERBOSE=on MB_OPENMSX_HEADLESS=off MB_OPENMSX_THROTTLE=on MB_OPENMSX_SPEED=100 make bin/@assert-all real 2m37.379s - debug run with screenshot on exit; (black screens without throttle) - time MB_OPENMSX_HEADLESS=off MB_OPENMSX_THROTTLE=on MB_FLIGHT_SCREEN=on make -s bin/@assert-all + record run with screenshot on exit; (black screens without throttle) + time MB_OPENMSX_HEADLESS=off MB_OPENMSX_THROTTLE=on MB_FLIGHT_SCREEN=on make bin/@assert-all real 1m14.043s - debug run with video recorder and merge to one video file; - time MB_OPENMSX_HEADLESS=off MB_FLIGHT_VIDEO=on make -s bin/@assert-all + record run with video per session and merge to one video file; + time MB_OPENMSX_HEADLESS=off MB_FLIGHT_VIDEO=on make bin/@assert-all real 0m7.136s build parallel; - time make -s -j4 bin/@assert-all + time make -j4 bin/@assert-all real 0m1.817s manual test msxhub on machine;