Skip to content

Commit

Permalink
docs: better ARG documentation for literal ampersand
Browse files Browse the repository at this point in the history
  • Loading branch information
tschettervictor authored Jan 15, 2025
1 parent 5ac744d commit 9bf492b
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/chapters/template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,14 @@ Template Automation Hooks
| SYSRC | sysrc command(s) | nginx_enable=YES |
+---------+-------------------+-----------------------------------------+

Special Cases
Special Hook Cases
------------------

SYSRC requires that NO quotes be used or that quotes (`"`) be escaped
ie; (`\\"`)

When using an ampersand "\&" in a template hook, and it is to be
interpreted literally, it must be escaped (`\\&`)
ARG requires an ampersand "\&" to be escaped (`\\&`) if it is to be interpreted
literally, otherwise it is treated as a special character.

Place these uppercase template hook commands into a `Bastillefile` in any order
and automate container setup as needed.
Expand Down

0 comments on commit 9bf492b

Please sign in to comment.