From 814b074cc0b89001bca66cdc3a7a1a67e33a6b8e Mon Sep 17 00:00:00 2001
From: Vaclav Barta <vbarta@mangrove.cz>
Date: Wed, 4 May 2022 14:22:25 +0200
Subject: [PATCH] added hooks-control-string-arg, hooks-release-define and
 hooks-skip-hash-buf-len docs

---
 xrpl-hooks-docs/docs.ts                        | 6 ++++++
 xrpl-hooks-docs/md/hooks-control-string-arg.md | 5 +++++
 xrpl-hooks-docs/md/hooks-release-define.md     | 5 +++++
 xrpl-hooks-docs/md/hooks-skip-hash-buf-len.md  | 5 +++++
 4 files changed, 21 insertions(+)
 create mode 100644 xrpl-hooks-docs/md/hooks-control-string-arg.md
 create mode 100644 xrpl-hooks-docs/md/hooks-release-define.md
 create mode 100644 xrpl-hooks-docs/md/hooks-skip-hash-buf-len.md

diff --git a/xrpl-hooks-docs/docs.ts b/xrpl-hooks-docs/docs.ts
index c4dc279..4913785 100644
--- a/xrpl-hooks-docs/docs.ts
+++ b/xrpl-hooks-docs/docs.ts
@@ -3,6 +3,7 @@ import hooksAccountConvBufLen from "./md/hooks-account-conv-buf-len.md";
 import hooksAccountConvPure from "./md/hooks-account-conv-pure.md";
 import hooksArrayBufLen from "./md/hooks-array-buf-len.md";
 import hooksBurdenPrereq from "./md/hooks-burden-prereq.md";
+import hooksControlStringArg from "./md/hooks-control-string-arg.md";
 import hooksDetailBufLen from "./md/hooks-detail-buf-len.md";
 import hooksDetailPrereq from "./md/hooks-detail-prereq.md";
 import hooksEmitBufLen from "./md/hooks-emit-buf-len.md";
@@ -29,12 +30,14 @@ import hooksParamBufLen from "./md/hooks-param-buf-len.md";
 import hooksParamSetBufLen from "./md/hooks-param-set-buf-len.md";
 import hooksRaddrConvBufLen from "./md/hooks-raddr-conv-buf-len.md";
 import hooksRaddrConvPure from "./md/hooks-raddr-conv-pure.md";
+import hooksReleaseDefine from "./md/hooks-release-define.md";
 import hooksReserveLimit from "./md/hooks-reserve-limit.md";
 import hooksSlotHashBufLen from "./md/hooks-slot-hash-buf-len.md";
 import hooksSlotKeyletBufLen from "./md/hooks-slot-keylet-buf-len.md";
 import hooksSlotLimit from "./md/hooks-slot-limit.md";
 import hooksSlotSubLimit from "./md/hooks-slot-sub-limit.md";
 import hooksSlotTypeLimit from "./md/hooks-slot-type-limit.md";
+import hooksSkipHashBufLen from "./md/hooks-skip-hash-buf-len.md";
 import hooksStateBufLen from "./md/hooks-state-buf-len.md";
 import hooksTransactionHashBufLen from "./md/hooks-transaction-hash-buf-len.md";
 import hooksTransactionSlotLimit from "./md/hooks-transaction-slot-limit.md";
@@ -49,6 +52,7 @@ const docs: { [key: string]: string; } = {
   "hooks-account-conv-pure": hooksAccountConvPure,
   "hooks-array-buf-len": hooksArrayBufLen,
   "hooks-burden-prereq": hooksBurdenPrereq,
+  "hooks-control-string-arg": hooksControlStringArg,
   "hooks-detail-buf-len": hooksDetailBufLen,
   "hooks-detail-prereq": hooksDetailPrereq,
   "hooks-emit-buf-len": hooksEmitBufLen,
@@ -75,12 +79,14 @@ const docs: { [key: string]: string; } = {
   "hooks-param-set-buf-len": hooksParamSetBufLen,
   "hooks-raddr-conv-buf-len": hooksRaddrConvBufLen,
   "hooks-raddr-conv-pure": hooksRaddrConvPure,
+  "hooks-release-define": hooksReleaseDefine,
   "hooks-reserve-limit": hooksReserveLimit,
   "hooks-slot-hash-buf-len": hooksSlotHashBufLen,
   "hooks-slot-keylet-buf-len": hooksSlotKeyletBufLen,
   "hooks-slot-limit": hooksSlotLimit,
   "hooks-slot-sub-limit": hooksSlotSubLimit,
   "hooks-slot-type-limit": hooksSlotTypeLimit,
+  "hooks-skip-hash-buf-len": hooksSkipHashBufLen,
   "hooks-state-buf-len": hooksStateBufLen,
   "hooks-transaction-hash-buf-len": hooksTransactionHashBufLen,
   "hooks-transaction-slot-limit": hooksTransactionSlotLimit,
diff --git a/xrpl-hooks-docs/md/hooks-control-string-arg.md b/xrpl-hooks-docs/md/hooks-control-string-arg.md
new file mode 100644
index 0000000..466f79a
--- /dev/null
+++ b/xrpl-hooks-docs/md/hooks-control-string-arg.md
@@ -0,0 +1,5 @@
+# hooks-control-string-arg
+
+Functions [accept](https://xrpl-hooks.readme.io/v2.0/reference/accept) and [rollback](https://xrpl-hooks.readme.io/v2.0/reference/rollback) take an optional string buffer stored outside the hook as its result message. This is useful for debugging but takes up space.
+
+For a release version, this check warns about constant strings passed to `accept` and `rollback`.
diff --git a/xrpl-hooks-docs/md/hooks-release-define.md b/xrpl-hooks-docs/md/hooks-release-define.md
new file mode 100644
index 0000000..888cd22
--- /dev/null
+++ b/xrpl-hooks-docs/md/hooks-release-define.md
@@ -0,0 +1,5 @@
+# hooks-release-define
+
+Hook users can define a `NDEBUG` macro to disable tracing calls at compile time - but for the definition to be effective, it must be defined before including hook-specific headers.
+
+This check warns when `NDEBUG` is defined too late.
diff --git a/xrpl-hooks-docs/md/hooks-skip-hash-buf-len.md b/xrpl-hooks-docs/md/hooks-skip-hash-buf-len.md
new file mode 100644
index 0000000..77679b0
--- /dev/null
+++ b/xrpl-hooks-docs/md/hooks-skip-hash-buf-len.md
@@ -0,0 +1,5 @@
+# hooks-skip-hash-buf-len
+
+Function [hook_skip](https://xrpl-hooks.readme.io/v2.0/reference/hook_skip) has fixed-size canonical hash input.
+
+This check warns about invalid size of its input buffer (if it's specified by a constant - variable parameter is ignored).