diff --git a/docs/_functions/domain/IGNORE_NAME.md b/docs/_functions/domain/IGNORE_NAME.md index d04f6bede..57c3e67b4 100644 --- a/docs/_functions/domain/IGNORE_NAME.md +++ b/docs/_functions/domain/IGNORE_NAME.md @@ -1,7 +1,13 @@ --- name: IGNORE_NAME +parameters: + - pattern --- +WARNING: The `IGNORE_*` family of functions is risky to use. The code +is brittle and has subtle bugs. Use at your own risk. Do not use these +commands with `D_EXTEND()` or use it at the domain apex. + IGNORE_NAME can be used to ignore some records present in zone. All records (independently of their type) of that name will be completely ignored. @@ -37,4 +43,4 @@ not match `.` * `IGNORE_NAME("{bar,[fz]oo}")` will ignore `bar`, `foo` and `zoo`. * `IGNORE_NAME("\\*.foo")` will ignore the literal record `*.foo`. -It is considered as an error to try to manage an ignored record. \ No newline at end of file +It is considered as an error to try to manage an ignored record. diff --git a/docs/_functions/domain/IGNORE_TARGET.md b/docs/_functions/domain/IGNORE_TARGET.md index 92070b03e..9b4f4b290 100644 --- a/docs/_functions/domain/IGNORE_TARGET.md +++ b/docs/_functions/domain/IGNORE_TARGET.md @@ -5,6 +5,10 @@ parameters: - rType --- +WARNING: The `IGNORE_*` family of functions is risky to use. The code +is brittle and has subtle bugs. Use at your own risk. Do not use these +commands with `D_EXTEND()` or use it at the domain apex. + IGNORE_TARGET can be used to ignore some records present in zone based on the record's target and type. IGNORE_TARGET currently only supports CNAME record types. IGNORE_TARGET is like NO_PURGE except it acts only on some specific records instead of the whole zone. @@ -31,4 +35,4 @@ IGNORE_TARGET also supports glob patterns in the style of the [gobwas/glob](http * `IGNORE_TARGET("**.bar", "CNAME")` will ignore all CNAME records with target subdomains of `bar`, including double subdomains such as `www.foo.bar`. * `IGNORE_TARGET("dev.*.foo", "CNAME")` will ignore all CNAME records with targets in the style of `dev.bar.foo`, but will not ignore records with targets using a double subdomain, such as `dev.foo.bar.foo`. -It is considered as an error to try to manage an ignored record. \ No newline at end of file +It is considered as an error to try to manage an ignored record.