瀏覽代碼

documentation is important

and usually comes as an afterthought
I nearly forgot to add this basic information for general usability
Imagine this not being a general requirement for all software
tags/v20240404
Chad C. Starz 1 月之前
父節點
當前提交
3b64702955
沒有發現已知的金鑰在資料庫的簽署中 GPG Key ID: CEEBC9208C287297
共有 3 個文件被更改,包括 18 次插入9 次删除
  1. +13
    -4
      README
  2. +4
    -4
      bake.1
  3. +1
    -1
      bake.c

+ 13
- 4
README 查看文件

@@ -44,16 +44,25 @@ are still supported, avoid these in the future.
They are most useful for a template command, such as:
@BAKE cc @FILENAME -o @SHORT @ARGS

Backslash, while otherwise ignored, will be respected at the end of the line
to concatenate lines together or if added to before any of listed macros will
yield the unfettered text.
Backslash, while otherwise ignored, will be respected at the end of the line to
concatenate lines together or if added to before any of listed macros will yield
the unfettered text. \SPECIAL_NAME will result in SPECIAL_NAME in the executed
shell command. Backslashes are applicable to all symbols used by Bake, they are
ignored otherwise.

--- Expunge Extension ---

Removes any singular file or directory non recursively defined within @{...},
this has no effect on the normal processing of the statement and is macro'd out
before it is executed.

--- Options ---

only one option may be in use at a time, and must come as the first argument.
Options must come as the first argument, and may be merged together, such as -xn.

-h, --help: displays help message, similarly to empty input.
-n, --dry-run: DRYRUN, does NOT run anything!
-x, --expunge: See above Expunge Extension section.

--- Shake ---



+ 4
- 4
bake.1 查看文件

@@ -17,7 +17,7 @@ appears.
\fBShake\fP does not support some features of \fBBake\fP, such as \fB@STOP\fP or \fBbinary files\fP,
please avoid its use.

Options [Only one, Must always be put first]
Options [Must always be put first, may be merged together]

.HP
.B \-v \-\-version, \-h \-\-help, \-n \-\-dry\-run
@@ -27,13 +27,13 @@ Expansions
These will expand to their counterpart statically first thing.
These may only be inserted inside of markers.
.TP
.B $@
.B @FILENAME, $@
returns target\-file (abc.x.txt)
.TP
.B $*
.B @SHORT, $*
returns target\-file without suffix (abc.x.txt \-> abc.x)
.TP
.B $+
.B @ARGS, $+
returns
.B arguments



+ 1
- 1
bake.c 查看文件

@@ -40,7 +40,7 @@
"rest of line, or if found within the file, until the " BOLD "@STOP" RESET " marker.\n" \

#define DESC \
"Options [Must always be first]\n" \
"Options [Must always be put first, may be merged together]\n" \
"\t" DIM "-h --help" RESET", " BOLD "-n --dry-run" RESET ", " BOLD "-x --expunge\n" RESET \
"Expansions\n" \
"\t" YELLOW "@FILENAME" RESET " returns target-file (abc.x.txt)\n" \


Loading…
取消
儲存