Deployed b19ddba with MkDocs version: 1.3.1

This commit is contained in:
2022-09-24 22:56:44 +00:00
parent 62d25023bc
commit 5ff0426480
18 changed files with 1242 additions and 266 deletions

View file

@ -263,6 +263,8 @@
@ -371,6 +373,49 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4" type="checkbox" id="__nav_3_4" >
<div class="md-nav__link md-nav__link--index ">
<a href="/task.mk/examples/recipe-help/">Recipe help</a>
</div>
<nav class="md-nav" aria-label="Recipe help" data-md-level="2">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Recipe help
</label>
<ul class="md-nav__list" data-md-scrollfix>
</ul>
</nav>
</li>
</ul>
</nav>
</li>

View file

@ -1,7 +1,7 @@
MAKEFLAGS += --no-print-directory
COLS ?= 60
ROWS ?= 20
EXAMPLES := check embedded
EXAMPLES := check embedded recipe-help
CASTS := $(addsuffix /demo.cast, $(EXAMPLES))
all: $(CASTS)

View file

@ -1,129 +1,84 @@
{"version": 2, "width": 48, "height": 12, "timestamp": 1663712361, "env": {"SHELL": "/usr/bin/zsh", "TERM": "xterm-256color"}}
[0.008114, "o", "\u001b[H\u001b[2J\u001b[3J"]
[0.00852, "o", "bash >> "]
[0.008755, "o", "m"]
[0.189398, "o", "a"]
[0.279744, "o", "k"]
[0.369775, "o", "e"]
[0.459919, "o", " -"]
[0.549908, "o", "f"]
[0.639982, "o", " "]
[0.730339, "o", "c"]
[0.820338, "o", "h"]
[0.910414, "o", "ec"]
[1.090651, "o", "k"]
[1.18077, "o", "/"]
[1.271098, "o", "c"]
[1.361098, "o", "h"]
[1.451216, "o", "ec"]
[1.541276, "o", "k"]
[1.631388, "o", "."]
[1.721603, "o", "m"]
[1.811718, "o", "k"]
[1.992079, "o", " h"]
[2.082138, "o", "e"]
[2.172379, "o", "l"]
[2.262403, "o", "p"]
[2.352473, "o", "\r\n"]
[3.381969, "o", "\u001b[1;36musage:\u001b[0m\r\n\tmake <recipe>\r\n\t\r\n\tinteractivity w/ task.mk\r\n\r\n\u001b[1;33m check\u001b[0m │ \u001b[2mget user confirmation or exit\u001b[0m\r\n\u001b[1;33m h, help\u001b[0m │ \u001b[2mshow this help\u001b[0m\r\n\r\n"]
[5.387545, "o", "\u001b[H\u001b[2J\u001b[3J"]
[5.387892, "o", "bash >> "]
[5.390047, "o", "m"]
[5.570645, "o", "a"]
[5.660579, "o", "k"]
[5.750852, "o", "e"]
[5.841071, "o", " -"]
[5.931225, "o", "f"]
[6.021286, "o", " "]
[6.111373, "o", "c"]
[6.201586, "o", "h"]
[6.291778, "o", "ec"]
[6.472054, "o", "k"]
[6.562124, "o", "/"]
[6.652262, "o", "c"]
[6.74248, "o", "h"]
[6.832675, "o", "ec"]
[6.922668, "o", "k"]
[7.012809, "o", "."]
[7.102973, "o", "m"]
[7.193151, "o", "k"]
[7.373458, "o", " c"]
[7.463783, "o", "h"]
[7.553761, "o", "e"]
[7.643931, "o", "c"]
[7.734197, "o", "k"]
[7.824356, "o", "\r\n"]
[8.857505, "o", "Would you like to proceed? \u001b[1;31m[Y/n]\u001b[0m "]
[9.54018, "o", "y"]
[9.595198, "o", "\r\n"]
[9.598684, "o", "you said yes!\r\n"]
[11.602689, "o", "#"]
[11.783071, "o", " "]
[11.873235, "o", "L"]
[11.963465, "o", "e"]
[12.053444, "o", "t'"]
[12.143548, "o", "s"]
[12.233881, "o", " "]
[12.323915, "o", "t"]
[12.41414, "o", "r"]
[12.50428, "o", "y "]
[12.684471, "o", "a"]
[12.774773, "o", "g"]
[12.864864, "o", "a"]
[12.954989, "o", "i"]
[13.045011, "o", "n "]
[13.135204, "o", "b"]
[13.225451, "o", "u"]
[13.315649, "o", "t"]
[13.405687, "o", " "]
[13.585943, "o", "in"]
[13.676051, "o", "s"]
[13.766346, "o", "t"]
[13.856324, "o", "e"]
[13.946542, "o", "a"]
[14.036697, "o", "d "]
[14.126782, "o", "s"]
[14.216944, "o", "a"]
[14.307128, "o", "y"]
[14.487468, "o", " "]
[14.577551, "o", "no"]
[14.667739, "o", " "]
[14.757899, "o", "t"]
[14.848007, "o", "h"]
[14.93806, "o", "i"]
[15.0283, "o", "s "]
[15.118379, "o", "t"]
[15.208471, "o", "i"]
[15.388757, "o", "m"]
[15.47897, "o", "e"]
[15.569031, "o", "\r\n"]
[16.571969, "o", "\u001b[H\u001b[2J\u001b[3J"]
[16.572047, "o", "bash >> "]
[16.574017, "o", "m"]
[16.754499, "o", "a"]
[16.844612, "o", "k"]
[16.93468, "o", "e"]
[17.024972, "o", " -"]
[17.115137, "o", "f"]
[17.205244, "o", " "]
[17.295415, "o", "c"]
[17.385554, "o", "h"]
[17.475882, "o", "ec"]
[17.655989, "o", "k"]
[17.746279, "o", "/"]
[17.83643, "o", "c"]
[17.926644, "o", "h"]
[18.016673, "o", "ec"]
[18.106718, "o", "k"]
[18.197045, "o", "."]
[18.287031, "o", "m"]
[18.377151, "o", "k"]
[18.55735, "o", " c"]
[18.647478, "o", "h"]
[18.737616, "o", "e"]
[18.827879, "o", "c"]
[18.917992, "o", "k"]
[19.008133, "o", "\r\n"]
[20.034923, "o", "Would you like to proceed? \u001b[1;31m[Y/n]\u001b[0m "]
[22.08808, "o", "n"]
[22.227223, "o", "\r\n"]
{"version": 2, "width": 48, "height": 12, "timestamp": 1664060067, "env": {"SHELL": "/usr/bin/zsh", "TERM": "xterm-256color"}}
[0.008028, "o", "\u001b[H\u001b[2J\u001b[3J"]
[0.008412, "o", "bash >> "]
[0.008649, "o", "ma"]
[0.189116, "o", "ke"]
[0.279092, "o", " -"]
[0.369181, "o", "f "]
[0.459296, "o", "ch"]
[0.549434, "o", "ec"]
[0.639704, "o", "k/"]
[0.729786, "o", "ch"]
[0.81994, "o", "ec"]
[0.910178, "o", "k."]
[1.090415, "o", "mk"]
[1.180666, "o", " h"]
[1.270767, "o", "el"]
[1.360807, "o", "p\r\n"]
[2.392643, "o", "\u001b[1;36musage:\u001b[0m\r\n\tmake <recipe>\r\n\t\r\n\tinteractivity w/ task.mk\r\n\r\n\u001b[1;33m check\u001b[0m │ \u001b[2mget user confirmation or exit\u001b[0m\r\n\u001b[1;33m h, help\u001b[0m │ \u001b[2mshow this help\u001b[0m\r\n\r\n"]
[4.398843, "o", "\u001b[H\u001b[2J\u001b[3J"]
[4.398948, "o", "bash >> "]
[4.399576, "o", "ma"]
[4.580421, "o", "ke"]
[4.670533, "o", " -"]
[4.760674, "o", "f "]
[4.850908, "o", "ch"]
[4.940859, "o", "ec"]
[5.031095, "o", "k/"]
[5.121228, "o", "ch"]
[5.211271, "o", "ec"]
[5.301383, "o", "k."]
[5.481587, "o", "mk"]
[5.571714, "o", " c"]
[5.662002, "o", "he"]
[5.752104, "o", "ck"]
[5.842305, "o", "\r\n"]
[6.864798, "o", "Would you like to proceed? \u001b[1;31m[Y/n]\u001b[0m "]
[7.488194, "o", "y"]
[7.830894, "o", "\r\n"]
[7.836313, "o", "you said yes!\r\n"]
[9.840217, "o", "# "]
[10.020704, "o", "Le"]
[10.110897, "o", "t'"]
[10.201077, "o", "s "]
[10.291171, "o", "tr"]
[10.381382, "o", "y "]
[10.471532, "o", "ag"]
[10.5617, "o", "ai"]
[10.651984, "o", "n "]
[10.742177, "o", "bu"]
[10.922348, "o", "t "]
[11.012569, "o", "in"]
[11.102605, "o", "st"]
[11.192785, "o", "ea"]
[11.282913, "o", "d "]
[11.373109, "o", "sa"]
[11.463146, "o", "y "]
[11.553266, "o", "no"]
[11.6436, "o", " t"]
[11.823731, "o", "hi"]
[11.913841, "o", "s "]
[12.003886, "o", "ti"]
[12.094101, "o", "me"]
[12.184197, "o", "\r\n"]
[13.185929, "o", "\u001b[H\u001b[2J\u001b[3J"]
[13.185977, "o", "bash >> "]
[13.186676, "o", "ma"]
[13.367108, "o", "ke"]
[13.457234, "o", " -"]
[13.547276, "o", "f "]
[13.637696, "o", "ch"]
[13.727919, "o", "ec"]
[13.817921, "o", "k/"]
[13.908217, "o", "ch"]
[13.998375, "o", "ec"]
[14.08855, "o", "k."]
[14.268802, "o", "mk"]
[14.359106, "o", " c"]
[14.449085, "o", "he"]
[14.539194, "o", "ck"]
[14.629387, "o", "\r\n"]
[15.652945, "o", "Would you like to proceed? \u001b[1;31m[Y/n]\u001b[0m "]
[16.544875, "o", "n"]
[17.098374, "o", "\r\n"]
[17.103306, "o", "make[1]: *** [check/check.mk:4: check] Error 1\r\n"]

View file

@ -272,6 +272,8 @@
@ -382,6 +384,49 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4" type="checkbox" id="__nav_3_4" >
<div class="md-nav__link md-nav__link--index ">
<a href="../recipe-help/">Recipe help</a>
</div>
<nav class="md-nav" aria-label="Recipe help" data-md-level="2">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Recipe help
</label>
<ul class="md-nav__list" data-md-scrollfix>
</ul>
</nav>
</li>
</ul>
</nav>
</li>

View file

@ -1,126 +1,83 @@
{"version": 2, "width": 60, "height": 20, "timestamp": 1663712193, "env": {"SHELL": "/usr/bin/zsh", "TERM": "xterm-256color"}}
[0.008386, "o", "\u001b[H\u001b[2J\u001b[3J"]
[0.008986, "o", "bash >> "]
[0.009151, "o", "m"]
[0.189701, "o", "a"]
[0.280162, "o", "k"]
[0.37038, "o", "e"]
[0.460683, "o", " -"]
[0.551001, "o", "f"]
[0.641267, "o", " "]
[0.731609, "o", "e"]
[0.821777, "o", "m"]
[0.912103, "o", "be"]
[1.092658, "o", "d"]
[1.182705, "o", "d"]
[1.273152, "o", "e"]
[1.363457, "o", "d"]
[1.453758, "o", "/e"]
[1.544059, "o", "m"]
[1.634282, "o", "b"]
[1.724452, "o", "e"]
[1.814601, "o", "d"]
[1.995155, "o", "de"]
[2.085437, "o", "d"]
[2.175546, "o", "."]
[2.265856, "o", "m"]
[2.356192, "o", "k"]
[2.446468, "o", " h"]
[2.536781, "o", "e"]
[2.627101, "o", "l"]
[2.717423, "o", "p"]
[2.897934, "o", "\r\n"]
[3.931131, "o", "\u001b[1;36musage:\u001b[0m\r\n\tmake <recipe>\r\n\t\r\n\texamples of embedded scripts in `\u001b[35mMakefile\u001b[0m`\r\n\r\n \u001b[1;31m examples of task.mk features \u001b[0m\r\n\u001b[38m ─────────────────────────────────────────────────────\u001b[0m\r\n\u001b[1;33m list-%\u001b[0m │ \u001b[2muse pathlib.Path to list files\u001b[0m\r\n \u001b[2mname the directory in rule (make list-src)\u001b[0m\r\n\u001b[1;33m embedded-bash\u001b[0m │ \u001b[2mbash script with pipes and make input\u001b[0m\r\n\u001b[1;33m h, help\u001b[0m │ \u001b[2mshow this help\u001b[0m\r\n\r\n"]
[5.936874, "o", "\u001b[H\u001b[2J\u001b[3J"]
[5.937167, "o", "bash >> "]
[5.939502, "o", "m"]
[6.120169, "o", "a"]
[6.210505, "o", "k"]
[6.300671, "o", "e"]
[6.390788, "o", " -"]
[6.480981, "o", "f"]
[6.571285, "o", " "]
[6.661457, "o", "e"]
[6.751758, "o", "m"]
[6.842048, "o", "be"]
[7.022576, "o", "d"]
[7.112852, "o", "d"]
[7.203064, "o", "e"]
[7.293421, "o", "d"]
[7.383397, "o", "/e"]
[7.473873, "o", "m"]
[7.564152, "o", "b"]
[7.65431, "o", "e"]
[7.744607, "o", "d"]
[7.925168, "o", "de"]
[8.015472, "o", "d"]
[8.105767, "o", "."]
[8.195936, "o", "m"]
[8.286184, "o", "k"]
[8.376537, "o", " l"]
[8.466624, "o", "i"]
[8.557058, "o", "s"]
[8.64739, "o", "t"]
[8.827942, "o", "-"]
[8.91803, "o", "em"]
[9.008446, "o", "b"]
[9.098742, "o", "e"]
[9.189059, "o", "d"]
[9.279328, "o", "d"]
[9.36965, "o", "ed"]
[9.459574, "o", "\r\n"]
[10.492826, "o", "files in embedded\r\n"]
[10.492943, "o", "['embedded.mk', 'demo.cast', 'record.sh', 'index.md']\r\n"]
[12.498865, "o", "\u001b[H\u001b[2J\u001b[3J"]
[12.498984, "o", "bash >> "]
[12.501382, "o", "m"]
[12.681906, "o", "a"]
[12.7722, "o", "k"]
[12.862501, "o", "e"]
[12.952783, "o", " -"]
[13.043086, "o", "f"]
[13.13339, "o", " "]
[13.223546, "o", "e"]
[13.313887, "o", "m"]
[13.40413, "o", "be"]
[13.584464, "o", "d"]
[13.674721, "o", "d"]
[13.764931, "o", "e"]
[13.855143, "o", "d"]
[13.945476, "o", "/e"]
[14.035801, "o", "m"]
[14.126086, "o", "b"]
[14.216402, "o", "e"]
[14.306688, "o", "d"]
[14.487263, "o", "de"]
[14.577566, "o", "d"]
[14.667572, "o", "."]
[14.757974, "o", "m"]
[14.848201, "o", "k"]
[14.938383, "o", " e"]
[15.02867, "o", "m"]
[15.118961, "o", "b"]
[15.2091, "o", "e"]
[15.38968, "o", "d"]
[15.479924, "o", "de"]
[15.570276, "o", "d"]
[15.66027, "o", "-"]
[15.750729, "o", "b"]
[15.84091, "o", "a"]
[15.931277, "o", "sh"]
[16.021429, "o", "\r\n"]
[17.044626, "o", "Is the process running bash? We can check with ps\r\n"]
[17.063304, "o", "bash\r\n"]
[17.063756, "o", "What text to figlet? \r\n"]
[20.107984, "o", "t"]
[20.125262, "o", "a"]
[20.276406, "o", "s"]
[20.454083, "o", "k"]
[20.705234, "o", "."]
[20.931947, "o", "m"]
[21.010096, "o", "k"]
[21.288327, "o", "\r\n"]
[21.292384, "o", " _ _ _ \r\n| |_ __ _ ___| | __ _ __ ___ | | __\r\n| __/ _` / __| |/ / | '_ ` _ \\| |/ /\r\n| || (_| \\__ \\ < _| | | | | | < \r\n \\__\\__,_|___/_|\\_(_)_| |_| |_|_|\\_\\\r\n \r\n"]
[21.292754, "o", "the argument below as given in the makefile itself\r\n"]
[21.292898, "o", "it's expanded before the script is passed to bash\r\n"]
[21.292925, "o", "bash multiline is probably working\r\n"]
{"version": 2, "width": 60, "height": 20, "timestamp": 1664060088, "env": {"SHELL": "/usr/bin/zsh", "TERM": "xterm-256color"}}
[0.008131, "o", "\u001b[H\u001b[2J\u001b[3J"]
[0.008522, "o", "bash >> "]
[0.008683, "o", "ma"]
[0.189166, "o", "ke"]
[0.279481, "o", " -"]
[0.369776, "o", "f "]
[0.460021, "o", "em"]
[0.550229, "o", "be"]
[0.640359, "o", "dd"]
[0.730591, "o", "ed"]
[0.820572, "o", "/e"]
[0.910745, "o", "mb"]
[1.091087, "o", "ed"]
[1.181312, "o", "de"]
[1.271441, "o", "d."]
[1.361501, "o", "mk"]
[1.451615, "o", " h"]
[1.541783, "o", "el"]
[1.63204, "o", "p\r\n"]
[2.664242, "o", "\u001b[1;36musage:\u001b[0m\r\n\tmake <recipe>\r\n\t\r\n\texamples of embedded scripts in `\u001b[35mMakefile\u001b[0m`\r\n\r\n \u001b[1;31m examples of task.mk features \u001b[0m\r\n\u001b[38m ─────────────────────────────────────────────────────\u001b[0m\r\n\u001b[1;33m list-%\u001b[0m │ \u001b[2muse pathlib.Path to list files\u001b[0m\r\n \u001b[2mname the directory in rule (make list-src)\u001b[0m\r\n\u001b[1;33m embedded-bash\u001b[0m │ \u001b[2mbash script with pipes and make input\u001b[0m\r\n\u001b[1;33m h, help\u001b[0m │ \u001b[2mshow this help\u001b[0m\r\n\r\n"]
[4.671801, "o", "\u001b[H\u001b[2J\u001b[3Jbash >> "]
[4.67392, "o", "ma"]
[4.854455, "o", "ke"]
[4.944728, "o", " -"]
[5.034921, "o", "f "]
[5.124982, "o", "em"]
[5.215103, "o", "be"]
[5.305188, "o", "dd"]
[5.395353, "o", "ed"]
[5.485457, "o", "/e"]
[5.576246, "o", "mb"]
[5.75589, "o", "ed"]
[5.846014, "o", "de"]
[5.93612, "o", "d."]
[6.026298, "o", "mk"]
[6.11644, "o", " l"]
[6.206464, "o", "is"]
[6.296631, "o", "t-"]
[6.386781, "o", "em"]
[6.477052, "o", "be"]
[6.657201, "o", "dd"]
[6.747412, "o", "ed"]
[6.837566, "o", "\r\n"]
[7.867599, "o", "files in embedded\r\n['embedded.mk', 'demo.cast', 'record.sh', 'index.md']\r\n"]
[9.872436, "o", "\u001b[H\u001b[2J\u001b[3J"]
[9.872754, "o", "bash >> "]
[9.874651, "o", "ma"]
[10.055031, "o", "ke"]
[10.145171, "o", " -"]
[10.235256, "o", "f "]
[10.325347, "o", "em"]
[10.415525, "o", "be"]
[10.505721, "o", "dd"]
[10.595814, "o", "ed"]
[10.685931, "o", "/e"]
[10.776068, "o", "mb"]
[10.956362, "o", "ed"]
[11.046547, "o", "de"]
[11.136692, "o", "d."]
[11.226851, "o", "mk"]
[11.316894, "o", " e"]
[11.406996, "o", "mb"]
[11.497205, "o", "ed"]
[11.58725, "o", "de"]
[11.677471, "o", "d-"]
[11.85761, "o", "ba"]
[11.947917, "o", "sh"]
[12.038071, "o", "\r\n"]
[13.045213, "o", "Is the process running bash? We can check with ps\r\n"]
[13.051057, "o", "bash\r\n"]
[13.051385, "o", "What text to figlet? \r\n"]
[14.434504, "o", "t"]
[14.503239, "o", "a"]
[14.605384, "o", "s"]
[14.745978, "o", "k"]
[14.946139, "o", "."]
[15.080651, "o", "m"]
[15.228545, "o", "k"]
[15.617669, "o", "\r\n"]
[15.618495, "o", " _ _ _ \r\n| |_ __ _ ___| | __ _ __ ___ | | __\r\n| __/ _` / __| |/ / | '_ ` _ \\| |/ /\r\n| || (_| \\__ \\ < _| | | | | | < \r\n \\__\\__,_|___/_|\\_(_)_| |_| |_|_|\\_\\\r\n \r\n"]
[15.618636, "o", "the argument below as given in the makefile itself\r\n"]
[15.618695, "o", "it's expanded before the script is passed to bash\r\nbash multiline is probably working\r\n"]

View file

@ -272,6 +272,8 @@
@ -382,6 +384,49 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4" type="checkbox" id="__nav_3_4" >
<div class="md-nav__link md-nav__link--index ">
<a href="../recipe-help/">Recipe help</a>
</div>
<nav class="md-nav" aria-label="Recipe help" data-md-level="2">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Recipe help
</label>
<ul class="md-nav__list" data-md-scrollfix>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
@ -522,6 +567,21 @@
</a>
<a href="../recipe-help/" class="md-footer__link md-footer__link--next" aria-label="Next: Recipe Help" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Recipe Help
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">

View file

@ -5,4 +5,5 @@ source "$(dirname "${BASH_SOURCE[0]}")/../functions.sh"
cmd 'make -f embedded/embedded.mk help'
cmd 'make -f embedded/embedded.mk list-embedded'
cmd 'make -f embedded/embedded.mk embedded-bash'
sleep 1

View file

@ -1,7 +1,7 @@
#!/usr/bin/env bash
msg() {
printf '%s\n' "$1" | pv -qL 12
printf '%s\n' "$1" | pv -qL 20
sleep 1
}

View file

@ -272,6 +272,8 @@
@ -380,6 +382,49 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4" type="checkbox" id="__nav_3_4" >
<div class="md-nav__link md-nav__link--index ">
<a href="recipe-help/">Recipe help</a>
</div>
<nav class="md-nav" aria-label="Recipe help" data-md-level="2">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Recipe help
</label>
<ul class="md-nav__list" data-md-scrollfix>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
@ -426,14 +471,18 @@
<h1 id="examples">Examples</h1>
<dl>
<dt><a href="./check"><code>Check</code></a></dt>
<dt><a href="./check">Confirm</a></dt>
<dd>
<p>Perform a basic confirmation test with the user and exit with error code 1 if input is N/n.</p>
</dd>
<dt><a href="./embedded"><code>Embedded</code></a></dt>
<dt><a href="./embedded">Embedded Scripts</a></dt>
<dd>
<p>Use the builtin functions to write multi-line python/bash scripts directly in your <code>Makefile</code></p>
</dd>
<dt><a href="./recipe-help">Recipe Help</a></dt>
<dd>
<p>Display the target, docstring and recipe for a given target then exit.</p>
</dd>
</dl>
<hr>
@ -441,7 +490,7 @@
<small>
Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 18, 2022</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 24, 2022</span>
<br>
Created:

View file

@ -0,0 +1,138 @@
{"version": 2, "width": 60, "height": 20, "timestamp": 1664060106, "env": {"SHELL": "/usr/bin/zsh", "TERM": "xterm-256color"}}
[0.007806, "o", "\u001b[H\u001b[2J\u001b[3J"]
[0.008354, "o", "bash >> "]
[0.008532, "o", "ma"]
[0.189207, "o", "ke"]
[0.279458, "o", " -"]
[0.369697, "o", "f "]
[0.459892, "o", "re"]
[0.550111, "o", "ci"]
[0.640099, "o", "pe"]
[0.730309, "o", "-h"]
[0.820408, "o", "el"]
[0.910572, "o", "p/"]
[1.090837, "o", "re"]
[1.180944, "o", "ci"]
[1.271024, "o", "pe"]
[1.36131, "o", "-h"]
[1.451464, "o", "el"]
[1.541712, "o", "p."]
[1.631676, "o", "mk"]
[1.721815, "o", " h"]
[1.812133, "o", "el"]
[1.99248, "o", "p\r\n"]
[3.025715, "o", "\u001b[1;36musage:\u001b[0m\r\n\tmake <recipe>\r\n\tmake help <recipe>\r\n\r\n\u001b[1;33m deps-only\u001b[0m │ \u001b[2ma task/target with dependencies\u001b[0m\r\n\u001b[1;33m foo\u001b[0m │ \u001b[2ma dummy rule that depends on the local files\u001b[0m\r\n\u001b[1;33m h, help\u001b[0m │ \u001b[2mshow this help\u001b[0m\r\n\r\n"]
[5.032814, "o", "\u001b[H\u001b[2J\u001b[3Jbash >> "]
[5.034705, "o", "ma"]
[5.215256, "o", "ke"]
[5.305482, "o", " -"]
[5.395504, "o", "f "]
[5.485805, "o", "re"]
[5.576036, "o", "ci"]
[5.666095, "o", "pe"]
[5.756177, "o", "-h"]
[5.846563, "o", "el"]
[5.93671, "o", "p/"]
[6.11689, "o", "re"]
[6.206935, "o", "ci"]
[6.297128, "o", "pe"]
[6.387205, "o", "-h"]
[6.477454, "o", "el"]
[6.567496, "o", "p."]
[6.657713, "o", "mk"]
[6.747729, "o", " h"]
[6.838006, "o", "el"]
[7.018242, "o", "p "]
[7.108261, "o", "he"]
[7.198405, "o", "lp"]
[7.288809, "o", "\r\n"]
[8.318829, "o", "\u001b[1;36mtask.mk recipe help\u001b[0m\r\n\r\n"]
[8.325694, "o", " \u001b[1;33mh help\u001b[0m\r\n\u001b[38m ────────────────────────────────────────────────────────\u001b[0m\r\n $(call py,help_py) || { echo \"exiting early!\"; exit 1; }\r\n\r\n"]
[8.329695, "o", "exiting early!\r\nmake[1]: *** [/home/daylin/dev/github/mine/task.mk/task.mk:30: help] Error 1\r\n"]
[10.332715, "o", "\u001b[H\u001b[2J\u001b[3J"]
[10.333056, "o", "bash >> "]
[10.335005, "o", "ma"]
[10.515605, "o", "ke"]
[10.605896, "o", " -"]
[10.696226, "o", "f "]
[10.78629, "o", "re"]
[10.876669, "o", "ci"]
[10.966704, "o", "pe"]
[11.056858, "o", "-h"]
[11.146831, "o", "el"]
[11.236969, "o", "p/"]
[11.417281, "o", "re"]
[11.507468, "o", "ci"]
[11.597442, "o", "pe"]
[11.687589, "o", "-h"]
[11.777832, "o", "el"]
[11.867969, "o", "p."]
[11.958105, "o", "mk"]
[12.048177, "o", " h"]
[12.138291, "o", "el"]
[12.318676, "o", "p "]
[12.408796, "o", "de"]
[12.498823, "o", "ps"]
[12.588985, "o", "-o"]
[12.679133, "o", "nl"]
[12.769237, "o", "y\r\n"]
[13.807661, "o", "\u001b[1;36mtask.mk recipe help\u001b[0m\r\n\r\n"]
[13.816448, "o", "\u001b[1;33m deps-only\u001b[0m │ \u001b[2ma task/target with dependencies\u001b[0m\r\n \u001b[38mdeps\u001b[0m: \u001b[2mfoo\u001b[0m\r\n\r\n"]
[13.820255, "o", "exiting early!\r\n"]
[13.820461, "o", "make[1]: *** [/home/daylin/dev/github/mine/task.mk/task.mk:30: help] Error 1\r\n"]
[15.823763, "o", "\u001b[H\u001b[2J\u001b[3J"]
[15.824036, "o", "bash >> "]
[15.826016, "o", "ma"]
[16.006673, "o", "ke"]
[16.09685, "o", " -"]
[16.186936, "o", "f "]
[16.277228, "o", "re"]
[16.367339, "o", "ci"]
[16.45744, "o", "pe"]
[16.547483, "o", "-h"]
[16.637622, "o", "el"]
[16.727742, "o", "p/"]
[16.907989, "o", "re"]
[16.99817, "o", "ci"]
[17.088391, "o", "pe"]
[17.178352, "o", "-h"]
[17.268476, "o", "el"]
[17.358766, "o", "p."]
[17.448842, "o", "mk"]
[17.539039, "o", " h"]
[17.629197, "o", "el"]
[17.809354, "o", "p "]
[17.899578, "o", "fo"]
[17.989694, "o", "o\r\n"]
[19.020047, "o", "\u001b[1;36mtask.mk recipe help\u001b[0m\r\n\r\n"]
[19.03039, "o", "\u001b[1;33m foo\u001b[0m │ \u001b[2ma dummy rule that depends on the local files\u001b[0m\r\n \u001b[38mdeps\u001b[0m: \u001b[2mcheck embedded functions.sh index.md Makefile recipe-help\u001b[0m\r\n\u001b[38m ────────────────────────────\u001b[0m\r\n @echo 'this is a dummy rule'\r\n\r\n"]
[19.035496, "o", "exiting early!\r\n"]
[19.035706, "o", "make[1]: *** [/home/daylin/dev/github/mine/task.mk/task.mk:30: help] Error 1\r\n"]
[21.039168, "o", "\u001b[H\u001b[2J\u001b[3J"]
[21.03927, "o", "bash >> "]
[21.041378, "o", "ma"]
[21.221916, "o", "ke"]
[21.31205, "o", " -"]
[21.402214, "o", "f "]
[21.492482, "o", "re"]
[21.582638, "o", "ci"]
[21.672609, "o", "pe"]
[21.762748, "o", "-h"]
[21.853045, "o", "el"]
[21.943154, "o", "p/"]
[22.123286, "o", "re"]
[22.2134, "o", "ci"]
[22.303509, "o", "pe"]
[22.393685, "o", "-h"]
[22.483815, "o", "el"]
[22.574005, "o", "p."]
[22.664056, "o", "mk"]
[22.754229, "o", " h"]
[22.844432, "o", "el"]
[23.02464, "o", "p "]
[23.114692, "o", "ba"]
[23.205123, "o", "r\r\n"]
[24.260098, "o", "\u001b[1;36mtask.mk recipe help\u001b[0m\r\n\r\n"]
[24.267129, "o", " \u001b[1;33mbar\u001b[0m\r\n\u001b[38m ─────────────────────────────────────\u001b[0m\r\n @echo 'some rule with no help string'\r\n\r\n"]
[24.271004, "o", "exiting early!\r\n"]
[24.271137, "o", "make[1]: *** [/home/daylin/dev/github/mine/task.mk/task.mk:30: help] Error 1\r\n"]

View file

@ -0,0 +1,596 @@
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://gh.dayl.in/task.mk/examples/recipe-help/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-8.5.3">
<title>Recipe Help - task.mk</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.7a952b86.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.cbb835fc.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../stylesheets/extra.css">
<link rel="stylesheet" href="../../stylesheets/asciinema-player.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="">
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#recipe-help" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="task.mk" class="md-header__button md-logo" aria-label="task.mk" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
task.mk
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Recipe Help
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="" data-md-color-accent="" aria-hidden="true" type="radio" name="__palette" id="__palette_1">
</form>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/daylinmorgan/task.mk" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
daylinmorgan/task.mk
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="task.mk" class="md-nav__button md-logo" aria-label="task.mk" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
task.mk
</label>
<div class="md-nav__source">
<a href="https://github.com/daylinmorgan/task.mk" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
daylinmorgan/task.mk
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
Home
</a>
</li>
<li class="md-nav__item">
<a href="../../usage/" class="md-nav__link">
Usage
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked>
<div class="md-nav__link md-nav__link--index ">
<a href="../">Examples</a>
<label for="__nav_3">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" aria-label="Examples" data-md-level="1">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Examples
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_2" type="checkbox" id="__nav_3_2" >
<div class="md-nav__link md-nav__link--index ">
<a href="../check/">Check</a>
</div>
<nav class="md-nav" aria-label="Check" data-md-level="2">
<label class="md-nav__title" for="__nav_3_2">
<span class="md-nav__icon md-icon"></span>
Check
</label>
<ul class="md-nav__list" data-md-scrollfix>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_3" type="checkbox" id="__nav_3_3" >
<div class="md-nav__link md-nav__link--index ">
<a href="../embedded/">Embedded</a>
</div>
<nav class="md-nav" aria-label="Embedded" data-md-level="2">
<label class="md-nav__title" for="__nav_3_3">
<span class="md-nav__icon md-icon"></span>
Embedded
</label>
<ul class="md-nav__list" data-md-scrollfix>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4" type="checkbox" id="__nav_3_4" checked>
<div class="md-nav__link md-nav__link--index md-nav__link--active">
<a href="./">Recipe help</a>
</div>
<nav class="md-nav" aria-label="Recipe help" data-md-level="2">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Recipe help
</label>
<ul class="md-nav__list" data-md-scrollfix>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/daylinmorgan/task.mk/edit/main/docs/examples/recipe-help/index.md" title="Edit this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z"/></svg>
</a>
<h1 id="recipe-help">Recipe Help</h1>
<div id="demo-cast"></div>
<div class="highlight"><span class="filename">recipe-help.mk</span><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c">## deps-only | a task/target with dependencies</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nf">.PHONY</span><span class="o">:</span> <span class="n">deps</span>-<span class="n">only</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="nf">deps-only</span><span class="o">:</span> <span class="n">foo</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="c">## foo | a dummy rule that depends on the local files</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="nf">.PHONY</span><span class="o">:</span> <span class="n">foo</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="nf">foo</span><span class="o">:</span> <span class="k">$(</span><span class="nv">wildcard</span> *<span class="k">)</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> @echo <span class="s1">&#39;this is a dummy rule&#39;</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="c"># bar but no docstring</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="nf">.PHONY</span><span class="o">:</span> <span class="n">bar</span>
<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="nf">bar</span><span class="o">:</span>
<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> @echo <span class="s1">&#39;some rule with no help string&#39;</span>
<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>
<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a><span class="cp">define USAGE</span>
<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="nf">{a.header}usage</span><span class="o">:</span>{<span class="n">a</span>.<span class="n">end</span>}
<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> make &lt;recipe&gt;
<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> make <span class="nb">help</span> &lt;recipe&gt;
<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a>
<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="cp">endef</span>
<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a>
<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a><span class="nv">.DEFAULT_GOAL</span> <span class="o">=</span> <span class="nb">help</span>
<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a><span class="cp">include $(shell git rev-parse --show-toplevel)/task.mk</span>
</code></pre></div>
<hr>
<div class="md-source-file">
<small>
Last update:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 24, 2022</span>
<br>
Created:
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 24, 2022</span>
</small>
</div>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../embedded/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Embedded" rel="prev">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</div>
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Previous
</span>
Embedded
</div>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.indexes"], "search": "../../assets/javascripts/workers/search.5bf1dace.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
<script src="../../assets/javascripts/bundle.37e9125f.min.js"></script>
<script src="../../javascripts/asciinema-player.min.js"></script>
<script async>
AsciinemaPlayer.create('./demo.cast', document.getElementById('demo-cast'),{loop: true});
</script>
</body>
</html>

View file

@ -0,0 +1,24 @@
## deps-only | a task/target with dependencies
.PHONY: deps-only
deps-only: foo
## foo | a dummy rule that depends on the local files
.PHONY: foo
foo: $(wildcard *)
@echo 'this is a dummy rule'
# bar but no docstring
.PHONY: bar
bar:
@echo 'some rule with no help string'
define USAGE
{a.header}usage:{a.end}
make <recipe>
make help <recipe>
endef
.DEFAULT_GOAL = help
include $(shell git rev-parse --show-toplevel)/task.mk

View file

@ -0,0 +1,11 @@
#!/usr/bin/env bash
source "$(dirname "${BASH_SOURCE[0]}")/../functions.sh"
cmd 'make -f recipe-help/recipe-help.mk help'
cmd 'make -f recipe-help/recipe-help.mk help help'
cmd 'make -f recipe-help/recipe-help.mk help deps-only'
cmd 'make -f recipe-help/recipe-help.mk help foo'
cmd 'make -f recipe-help/recipe-help.mk help bar'
sleep 1

View file

@ -328,6 +328,8 @@
@ -436,6 +438,49 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4" type="checkbox" id="__nav_3_4" >
<div class="md-nav__link md-nav__link--index ">
<a href="examples/recipe-help/">Recipe help</a>
</div>
<nav class="md-nav" aria-label="Recipe help" data-md-level="2">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Recipe help
</label>
<ul class="md-nav__list" data-md-scrollfix>
</ul>
</nav>
</li>
</ul>
</nav>
</li>

File diff suppressed because one or more lines are too long

View file

@ -2,27 +2,32 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://gh.dayl.in/task.mk/</loc>
<lastmod>2022-09-22</lastmod>
<lastmod>2022-09-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://gh.dayl.in/task.mk/usage/</loc>
<lastmod>2022-09-22</lastmod>
<lastmod>2022-09-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://gh.dayl.in/task.mk/examples/</loc>
<lastmod>2022-09-22</lastmod>
<lastmod>2022-09-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://gh.dayl.in/task.mk/examples/check/</loc>
<lastmod>2022-09-22</lastmod>
<lastmod>2022-09-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://gh.dayl.in/task.mk/examples/embedded/</loc>
<lastmod>2022-09-22</lastmod>
<lastmod>2022-09-24</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://gh.dayl.in/task.mk/examples/recipe-help/</loc>
<lastmod>2022-09-24</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

Binary file not shown.

View file

@ -318,6 +318,8 @@
@ -426,6 +428,49 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3_4" type="checkbox" id="__nav_3_4" >
<div class="md-nav__link md-nav__link--index ">
<a href="../examples/recipe-help/">Recipe help</a>
</div>
<nav class="md-nav" aria-label="Recipe help" data-md-level="2">
<label class="md-nav__title" for="__nav_3_4">
<span class="md-nav__icon md-icon"></span>
Recipe help
</label>
<ul class="md-nav__list" data-md-scrollfix>
</ul>
</nav>
</li>
</ul>
</nav>
</li>