From 2dffec366ce9c4fa24c094b05e0000f9099000bc Mon Sep 17 00:00:00 2001 From: Eberhard Beilharz Date: Mon, 6 May 2024 15:07:37 +0200 Subject: [PATCH] docs(common): improve formatting of `builder.md` --- resources/build/builder.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/resources/build/builder.md b/resources/build/builder.md index 3855288392..0d0c385c50 100644 --- a/resources/build/builder.md +++ b/resources/build/builder.md @@ -86,13 +86,12 @@ This somewhat unwieldy incantation handles all our build environments. The intent is to get a good solid consistent path for the script so that we can safely include the build script, no matter what `pwd` is when the script is run. - The only modification permissible in this block is the `` text which will be a series of `../` paths taking us to the repository root from the location of the script itself. It is essential to make the include relative to the repo root, even for scripts -under the resources/ folder. Doing this gives us significant performance +under the `resources/` folder. Doing this gives us significant performance benefits. Inclusion of other scripts should be kept outside this standard build script @@ -1030,4 +1029,4 @@ Note: it is recommended that you use `$(builder_term text)` instead of [`builder_echo`]: #builderecho-function [`builder_die`]: #builderdie-function [`builder_echo_debug`]: #builderechodebug-function -[`builder_is_debug_build`]: #builderisdebugbuild-function \ No newline at end of file +[`builder_is_debug_build`]: #builderisdebugbuild-function