summaryrefslogtreecommitdiff
path: root/xC-gen-proto.awk
diff options
context:
space:
mode:
authorPřemysl Eric Janouch <p@janouch.name>2022-09-16 03:52:28 +0200
committerPřemysl Eric Janouch <p@janouch.name>2022-09-16 03:52:49 +0200
commitb55bae50df96b3258057ad17e7a08083d08b4819 (patch)
treea66f899920b5e1f9247acd653ae3fe4ea798fa37 /xC-gen-proto.awk
parent430968e5d5fdf627ce7e1563bbee22bf2f9256b2 (diff)
downloadxK-b55bae50df96b3258057ad17e7a08083d08b4819.tar.gz
xK-b55bae50df96b3258057ad17e7a08083d08b4819.tar.xz
xK-b55bae50df96b3258057ad17e7a08083d08b4819.zip
Update some documentation
Diffstat (limited to 'xC-gen-proto.awk')
-rw-r--r--xC-gen-proto.awk10
1 files changed, 5 insertions, 5 deletions
diff --git a/xC-gen-proto.awk b/xC-gen-proto.awk
index de8e9b8..ad375af 100644
--- a/xC-gen-proto.awk
+++ b/xC-gen-proto.awk
@@ -9,7 +9,7 @@
# Native types: bool, u{8,16,32,64}, i{8,16,32,64}, string
#
# Don't define any new types, unless you hate yourself, then it's okay to do so.
-# Both backends are a pain in the arse, for different reasons.
+# Backends tend to be a pain in the arse, for different reasons.
#
# All numbers are encoded in big-endian byte order.
# Booleans are one byte each.
@@ -18,11 +18,11 @@
# Enumeration values automatically start at 1, and are encoded as i8.
# Any struct or union field may be a variable-length array.
#
-# Message framing is done externally, but also happens to prefix u32 lengths.
+# Message framing is done externally, but also happens to prefix u32 lengths,
+# unless this role is already filled by, e.g., WebSocket.
#
-# Usage: env LC_ALL=C awk -v prefix=Relay \
-# -f xC-gen-proto.awk < xC-proto \
-# -f xC-gen-proto-{c,go}.awk > xC-proto.{c,go} | {clang-format,gofmt}
+# Usage: env LC_ALL=C awk -f xC-gen-proto.awk -f xC-gen-proto-{c,go,js}.awk \
+# xC-proto > xC-proto.{c,go,js} | {clang-format,gofmt,...}
# --- Utilities ----------------------------------------------------------------