2022-09-18 10:11:50 -05:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
2022-09-18 15:06:00 -05:00
< link rel = "canonical" href = "https://gh.dayl.in/task.mk/usage/" >
2022-09-18 10:11:50 -05:00
< link rel = "icon" href = "../assets/images/favicon.png" >
< meta name = "generator" content = "mkdocs-1.3.1, mkdocs-material-8.5.2" >
< title > Usage - task.mk< / title >
< link rel = "stylesheet" href = "../assets/stylesheets/main.9f9400aa.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 = "#usage" 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" >
Usage
< / 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 md-nav__item--active" >
< input class = "md-nav__toggle md-toggle" data-md-toggle = "toc" type = "checkbox" id = "__toc" >
< label class = "md-nav__link md-nav__link--active" for = "__toc" >
Usage
< span class = "md-nav__icon md-icon" > < / span >
< / label >
< a href = "./" class = "md-nav__link md-nav__link--active" >
Usage
< / a >
< nav class = "md-nav md-nav--secondary" aria-label = "Table of contents" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#configuration" class = "md-nav__link" >
Configuration
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#advanced-usage-embedded-python-scripts" class = "md-nav__link" >
Advanced Usage: Embedded Python Scripts
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle" data-md-toggle = "__nav_3" type = "checkbox" id = "__nav_3" >
< div class = "md-nav__link md-nav__link--index " >
< a href = "../examples/" > 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 = "../examples/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 = "../examples/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 >
< / 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" >
< label class = "md-nav__title" for = "__toc" >
< span class = "md-nav__icon md-icon" > < / span >
Table of contents
< / label >
< ul class = "md-nav__list" data-md-component = "toc" data-md-scrollfix >
< li class = "md-nav__item" >
< a href = "#configuration" class = "md-nav__link" >
Configuration
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#advanced-usage-embedded-python-scripts" class = "md-nav__link" >
Advanced Usage: Embedded Python Scripts
< / a >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
2022-09-19 00:01:42 -05:00
< a href = "https://github.com/daylinmorgan/task.mk/edit/main/docs/usage.md" title = "Edit this page" class = "md-content__button md-icon" >
2022-09-18 10:11:50 -05:00
< 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 = "usage" > Usage< / h1 >
< p > < code > Task.mk< / code > will add access to a recipe < code > help< / code > (also aliased to < code > h< / code > ).
In order to use < code > make help< / code > to you will need to add some custom comments to your < code > Makefile< / code > .< / p >
< p > Deliberately, I don't get names from recipes themselves.
This not only greatly simplifies the parsing but add's some opportunity to customize the output.
Such as to document wildcard or redundant recipes.< / p >
< p > You can place these anywhere, but I recommend adding these notes directly above their relevant recipes.
The format is < code > ## < recipe> | < msg> < / code > < / p >
< div class = "highlight" > < pre > < span > < / span > < code > < a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" > < / a > < span class = "c" > ## build | build the project< / 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" > build< / span >
< a id = "__codelineno-0-3" name = "__codelineno-0-3" href = "#__codelineno-0-3" > < / a > < span class = "nf" > build< / span > < span class = "o" > :< / span >
< a id = "__codelineno-0-4" name = "__codelineno-0-4" href = "#__codelineno-0-4" > < / a > ...
< / code > < / pre > < / div >
< p > Now when you invoke < code > make help< / code > it will parse these and generate your help output.< / p >
< p > In addition to a generic help output you can expose some configuration settings with < code > make vars< / code > .
To do so define the variables you'd like to print with < code > PRINT_VARS := VAR1 VAR2 VAR3< / code > .< / p >
< p > In addition to the < code > help< / code > and < code > vars< / code > recipes you can use a custom make function to format your text for fancier output.
For this there are two options depending on your needs < code > tprint< / code > or < code > tprint-sh< / code > . (< code > tprint-sh< / code > is for use within a multiline sub-shell that has already been silenced, see the version-check rule of this project's < code > Makefile< / code > for an example.)< / p >
< p > To use < code > tprint< / code > you call it with the builtin < code > make< / code > call function.
It accepts only one argument: an unquoted f-string literal.
All strings passed to < code > tprint< / code > have access to an object < code > ansi< / code > or < code > a< / code > for simplicity.
This stores ANSI escape codes which can be used to style your text.< / p >
< p > < div class = "highlight" > < pre > < span > < / span > < code > < a id = "__codelineno-1-1" name = "__codelineno-1-1" href = "#__codelineno-1-1" > < / a > < span class = "c" > ## build | compile the source< / span >
< a id = "__codelineno-1-2" name = "__codelineno-1-2" href = "#__codelineno-1-2" > < / a > < span class = "nf" > .PHONY< / span > < span class = "o" > :< / span > < span class = "n" > build< / span >
< a id = "__codelineno-1-3" name = "__codelineno-1-3" href = "#__codelineno-1-3" > < / a > < span class = "nf" > build< / span > < span class = "o" > :< / span >
< a id = "__codelineno-1-4" name = "__codelineno-1-4" href = "#__codelineno-1-4" > < / a > < span class = "k" > $(< / span > call tprint,< span class = "o" > {< / span > a.cyan< span class = "o" > }< / span > Build Starting< span class = "o" > {< / span > a.end< span class = "o" > }< / span > < span class = "k" > )< / span >
< a id = "__codelineno-1-5" name = "__codelineno-1-5" href = "#__codelineno-1-5" > < / a > ...
< a id = "__codelineno-1-6" name = "__codelineno-1-6" href = "#__codelineno-1-6" > < / a > < span class = "k" > $(< / span > call tprint,< span class = "o" > {< / span > a.green< span class = "o" > }< / span > Build Finished< span class = "o" > {< / span > a.end< span class = "o" > }< / span > < span class = "k" > )< / span >
< / code > < / pre > < / div >
See this projects < code > make info< / code > for more examples of < code > tprint< / code > .< / p >
< p > To see the available colors and formatting(bold,italic,etc.) use the hidden recipe < code > make _print-ansi< / code > .< / p >
< p > < strong > Note< / strong > : Any help commands starting with an underscore will be ignored.
To view hidden < code > tasks< / code > (or recipes in GNU Make land) you can use < code > make _help< / code > .< / p >
< p > In addition, you can use custom colors using the builtin < code > ansi.custom< / code > or (< code > a.custom< / code > ) method.
It has two optional arguments < code > fg< / code > and < code > bg< / code > . Which can be used to specify either an 8-bit color from the < a href = "https://en.wikipedia.org/wiki/8-bit_color" > 256 colors< / a > .
Or a tuple/list to define an RBG 24-bit color, for instance < code > a.custom(fg=(5,10,255))< / code > .
See this project's < code > make info< / code > for an example.< / p >
< h2 id = "configuration" > Configuration< / h2 >
< p > You can quickly customize some of the default behavior of < code > task.mk< / code > by overriding the below variables prior to the < code > -include .task.mk< / code > .< / p >
< div class = "highlight" > < pre > < span > < / span > < code > < a id = "__codelineno-2-1" name = "__codelineno-2-1" href = "#__codelineno-2-1" > < / a > < span class = "c" > # ---- CONFIG ---- #< / span >
< a id = "__codelineno-2-2" name = "__codelineno-2-2" href = "#__codelineno-2-2" > < / a > < span class = "nv" > HEADER_STYLE< / span > < span class = "o" > ?=< / span > b_cyan
< a id = "__codelineno-2-3" name = "__codelineno-2-3" href = "#__codelineno-2-3" > < / a > < span class = "nv" > PARAMS_STYLE< / span > < span class = "o" > ?=< / span > b_magenta
< a id = "__codelineno-2-4" name = "__codelineno-2-4" href = "#__codelineno-2-4" > < / a > < span class = "nv" > ACCENT_STYLE< / span > < span class = "o" > ?=< / span > b_yellow
< a id = "__codelineno-2-5" name = "__codelineno-2-5" href = "#__codelineno-2-5" > < / a > < span class = "nv" > GOAL_STYLE< / span > < span class = "o" > ?=< / span > < span class = "k" > $(< / span > ACCENT_STYLE< span class = "k" > )< / span >
< a id = "__codelineno-2-6" name = "__codelineno-2-6" href = "#__codelineno-2-6" > < / a > < span class = "nv" > MSG_STYLE< / span > < span class = "o" > ?=< / span > faint
< a id = "__codelineno-2-7" name = "__codelineno-2-7" href = "#__codelineno-2-7" > < / a > < span class = "nv" > DIVIDER_STYLE< / span > < span class = "o" > ?=< / span > default
< a id = "__codelineno-2-8" name = "__codelineno-2-8" href = "#__codelineno-2-8" > < / a > < span class = "nv" > DIVIDER< / span > < span class = "o" > ?=< / span > ─
< a id = "__codelineno-2-9" name = "__codelineno-2-9" href = "#__codelineno-2-9" > < / a > < span class = "nv" > HELP_SEP< / span > < span class = "o" > ?=< / span > │
< a id = "__codelineno-2-10" name = "__codelineno-2-10" href = "#__codelineno-2-10" > < / a >
< a id = "__codelineno-2-11" name = "__codelineno-2-11" href = "#__codelineno-2-11" > < / a > < span class = "c" > # python f-string literals< / span >
< a id = "__codelineno-2-12" name = "__codelineno-2-12" href = "#__codelineno-2-12" > < / a > < span class = "nv" > EPILOG< / span > < span class = "o" > ?=< / span >
< a id = "__codelineno-2-13" name = "__codelineno-2-13" href = "#__codelineno-2-13" > < / a > < span class = "cp" > define USAGE ?=< / span >
< a id = "__codelineno-2-14" name = "__codelineno-2-14" href = "#__codelineno-2-14" > < / a > < span class = "nf" > {ansi.$(HEADER_STYLE)}usage{ansi.end}< / span > < span class = "o" > :< / span >
< a id = "__codelineno-2-15" name = "__codelineno-2-15" href = "#__codelineno-2-15" > < / a > make < recipe>
< a id = "__codelineno-2-16" name = "__codelineno-2-16" href = "#__codelineno-2-16" > < / a >
< a id = "__codelineno-2-17" name = "__codelineno-2-17" href = "#__codelineno-2-17" > < / a > < span class = "cp" > endef< / span >
< / code > < / pre > < / div >
< p > To use a custom color for one of the predefined configuration variables specify only the custom method.< / p >
< div class = "highlight" > < pre > < span > < / span > < code > < a id = "__codelineno-3-1" name = "__codelineno-3-1" href = "#__codelineno-3-1" > < / a > < span class = "nv" > HEADER_STYLE< / span > < span class = "o" > =< / span > custom< span class = "o" > (< / span > < span class = "nv" > fg< / span > < span class = "o" > =< / span > < span class = "m" > 171< / span > ,bg< span class = "o" > =< / span > < span class = "m" > 227< / span > < span class = "o" > )< / span >
< / code > < / pre > < / div >
< p > < strong > NOTE< / strong > : < code > HELP_SEP< / code > does not change the argument definitions syntax only the format of < code > make help< / code > .< / p >
< h2 id = "advanced-usage-embedded-python-scripts" > Advanced Usage: Embedded Python Scripts< / h2 >
< p > You can take advantage of the builtin python script runner and write multi-line python scripts of your own.
This is a simple example but a few lines of python in your < code > Makefile< / code >
may be easier than balancing sub-shells and strung together awk commands.< / p >
< p > When < code > make< / code > expands the function it will take the parameters passed to < code > py< / code > and expand them.
< code > $(1)< / code > is the variable name and < code > $(2)< / code > in this case is the implicit pattern from the rule. Pay attention to quotes.
If you need to debug your python script, use < code > DEBUG=1< / code > when you run < code > make< / code > and it will first print the script that will be piped to < code > python< / code > .< / p >
< div class = "highlight" > < pre > < span > < / span > < code > < a id = "__codelineno-4-1" name = "__codelineno-4-1" href = "#__codelineno-4-1" > < / a > < span class = "cp" > define list_files_py< / span >
< a id = "__codelineno-4-2" name = "__codelineno-4-2" href = "#__codelineno-4-2" > < / a > < span class = "err" > from< / span > < span class = "w" > < / span > < span class = "err" > pathlib< / span > < span class = "w" > < / span > < span class = "err" > import< / span > < span class = "w" > < / span > < span class = "err" > Path< / span > < span class = "w" > < / span >
< a id = "__codelineno-4-3" name = "__codelineno-4-3" href = "#__codelineno-4-3" > < / a > < span class = "err" > print(< / span > < span class = "s2" > " files in $(2)" < / span > < span class = "err" > )< / span > < span class = "w" > < / span >
< a id = "__codelineno-4-4" name = "__codelineno-4-4" href = "#__codelineno-4-4" > < / a > < span class = "err" > print([f.name< / span > < span class = "w" > < / span > < span class = "err" > for< / span > < span class = "w" > < / span > < span class = "err" > f< / span > < span class = "w" > < / span > < span class = "err" > in< / span > < span class = "w" > < / span > < span class = "err" > (Path(< / span > < span class = "s2" > " $(2)" < / span > < span class = "err" > ).iterdir())])< / span > < span class = "w" > < / span >
< a id = "__codelineno-4-5" name = "__codelineno-4-5" href = "#__codelineno-4-5" > < / a > < span class = "cp" > endef< / span >
< a id = "__codelineno-4-6" name = "__codelineno-4-6" href = "#__codelineno-4-6" > < / a >
< a id = "__codelineno-4-7" name = "__codelineno-4-7" href = "#__codelineno-4-7" > < / a > < span class = "c" > ## list-% | use pathlib.Path to list files< / span >
< a id = "__codelineno-4-8" name = "__codelineno-4-8" href = "#__codelineno-4-8" > < / a > < span class = "nf" > list-%< / span > < span class = "o" > :< / span >
< a id = "__codelineno-4-9" name = "__codelineno-4-9" href = "#__codelineno-4-9" > < / a > < span class = "k" > $(< / span > call py,list_files_py,< span class = "nv" > $*< / span > < span class = "k" > )< / span >
< / code > < / pre > < / div >
< p > For what it's worth there is also a predefined function for < code > bash< / code > (named < code > tbash< / code > ) as well should you need to accomplish something similar of more easily embedding your bash script rather than having to escape every line with a backslash.< / p >
< div class = "highlight" > < pre > < span > < / span > < code > < a id = "__codelineno-5-1" name = "__codelineno-5-1" href = "#__codelineno-5-1" > < / a > < span class = "cp" > define bash_script< / span >
< a id = "__codelineno-5-2" name = "__codelineno-5-2" href = "#__codelineno-5-2" > < / a > < span class = "nf" > figlet task.mk 2> /dev/null || echo ' no figlet < / span > < span class = "o" > :< / span > ('
< a id = "__codelineno-5-3" name = "__codelineno-5-3" href = "#__codelineno-5-3" > < / a > < span class = "err" > echo< / span > < span class = "w" > < / span > < span class = "s2" > " This is from bash" < / span > < span class = "w" > < / span >
< a id = "__codelineno-5-4" name = "__codelineno-5-4" href = "#__codelineno-5-4" > < / a > < span class = "err" > cat< / span > < span class = "w" > < / span > < span class = "err" > /etc/hostname< / span > < span class = "w" > < / span >
< a id = "__codelineno-5-5" name = "__codelineno-5-5" href = "#__codelineno-5-5" > < / a > < span class = "err" > printf< / span > < span class = "w" > < / span > < span class = "s2" > " %s\n" < / span > < span class = "w" > < / span > < span class = "s2" > " $(2)" < / span > < span class = "w" > < / span >
< a id = "__codelineno-5-6" name = "__codelineno-5-6" href = "#__codelineno-5-6" > < / a > < span class = "cp" > endef< / span >
< a id = "__codelineno-5-7" name = "__codelineno-5-7" href = "#__codelineno-5-7" > < / a > < span class = "nf" > .PHONY< / span > < span class = "o" > :< / span > < span class = "n" > test< / span > -< span class = "n" > bash< / span >
< a id = "__codelineno-5-8" name = "__codelineno-5-8" href = "#__codelineno-5-8" > < / a > < span class = "nf" > test-bash< / span > < span class = "o" > :< / span >
< a id = "__codelineno-5-9" name = "__codelineno-5-9" href = "#__codelineno-5-9" > < / a > < span class = "k" > $(< / span > call tbash,bash_script,test bash multiline< span class = "k" > )< / 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 18, 2022< / span >
< br >
Created:
2022-09-18 15:06:00 -05:00
< span class = "git-revision-date-localized-plugin git-revision-date-localized-plugin-date" > September 5, 2022< / span >
2022-09-18 10:11:50 -05:00
< / small >
< / div >
< / article >
< / div >
< / div >
< / main >
< footer class = "md-footer" >
< nav class = "md-footer__inner md-grid" aria-label = "Footer" >
< a href = ".." class = "md-footer__link md-footer__link--prev" aria-label = "Previous: Home" 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 >
Home
< / div >
< / div >
< / a >
< a href = "../examples/" class = "md-footer__link md-footer__link--next" aria-label = "Next: Examples" rel = "next" >
< div class = "md-footer__title" >
< div class = "md-ellipsis" >
< span class = "md-footer__direction" >
Next
< / span >
Examples
< / 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" >
< 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.ecf98df9.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 >
2022-09-19 00:01:42 -05:00
2022-09-18 10:11:50 -05:00
< script src = "../assets/javascripts/bundle.39f04ddb.min.js" > < / script >
2022-09-19 00:01:42 -05:00
< script src = "../javascripts/asciinema-player.min.js" > < / script >
2022-09-18 10:11:50 -05:00
2022-09-19 00:01:42 -05:00
2022-09-18 10:11:50 -05:00
< / body >
< / html >
