diff options
| author | Dave Henderson <dhenderson@gmail.com> | 2020-08-10 10:48:01 -0400 |
|---|---|---|
| committer | Dave Henderson <dhenderson@gmail.com> | 2020-08-23 19:31:31 -0400 |
| commit | 4be2c38bab8877d69d5f8f4a5f0370b6672fe0e6 (patch) | |
| tree | 3f9edd6bddeaaba5717f490231bd35eebdf58891 /docs-src | |
| parent | 406832735e6c2d4f1598502405058f543b1ca16e (diff) | |
Add experimental mode
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
Diffstat (limited to 'docs-src')
| -rw-r--r-- | docs-src/content/functions/crypto.yml | 5 | ||||
| -rw-r--r-- | docs-src/content/functions/func_doc.md.tmpl | 18 |
2 files changed, 21 insertions, 2 deletions
diff --git a/docs-src/content/functions/crypto.yml b/docs-src/content/functions/crypto.yml index bf31163e..1602b5d9 100644 --- a/docs-src/content/functions/crypto.yml +++ b/docs-src/content/functions/crypto.yml @@ -55,6 +55,7 @@ funcs: $ gomplate -i '{{ crypto.PBKDF2 "foo" "bar" 1024 8 }}' 32c4907c3c80792b - name: crypto.RSADecrypt + experimental: true description: | Decrypt an RSA-encrypted input and print the output as a string. Note that this may result in unreadable text if the decrypted payload is binary. See @@ -87,6 +88,7 @@ funcs: -i '{{ base64.DecodeBytes .ciphertext | crypto.RSADecrypt .privKey }}' hello - name: crypto.RSADecryptBytes + experimental: true description: | Decrypt an RSA-encrypted input and output the decrypted byte array. @@ -120,6 +122,7 @@ funcs: {{ crypto.RSADecryptBytes .privKey $enc | conv.ToString }}' hello - name: crypto.RSAEncrypt + experimental: true description: | Encrypt the input with RSA and the padding scheme from PKCS#1 v1.5. @@ -158,6 +161,7 @@ funcs: Ciphertext in hex: {{ printf "%x" $enc }}' 71729b87cccabb248b9e0e5173f0b12c01d9d2a0565bad18aef9d332ce984bde06acb8bb69334a01446f7f6430077f269e6fbf2ccacd972fe5856dd4719252ebddf599948d937d96ea41540dad291b868f6c0cf647dffdb5acb22cd33557f9a1ddd0ee6c1ad2bbafc910ba8f817b66ea0569afc06e5c7858fd9dc2638861fe7c97391b2f190e4c682b4aa2c9b0050081efe18b10aa8c2b2b5f5b68a42dcc06c9da35b37fca9b1509fddc940eb99f516a2e0195405bcb3993f0fa31bc038d53d2e7231dff08cc39448105ed2d0ac52d375cb543ca8a399f807cc5d007e2c44c69876d189667eee66361a393c4916826af77479382838cd4e004b8baa05636805a - name: crypto.RSAGenerateKey + experimental: true description: | Generate a new RSA Private Key and output in PEM-encoded PKCS#1 ASN.1 DER form. @@ -184,6 +188,7 @@ funcs: {{ crypto.RSADecrypt $key $enc }}' hello - name: crypto.RSADerivePublicKey + experimental: true description: | Derive a public key from an RSA private key and output in PKIX ASN.1 DER form. diff --git a/docs-src/content/functions/func_doc.md.tmpl b/docs-src/content/functions/func_doc.md.tmpl index c66b0d09..0e8668de 100644 --- a/docs-src/content/functions/func_doc.md.tmpl +++ b/docs-src/content/functions/func_doc.md.tmpl @@ -24,9 +24,23 @@ menu: {{ $data.preamble -}} +{{- define "annotations" -}} +{{ if has . "deprecated" }} _(deprecated)_{{ end -}} +{{ if and (has . "experimental") (index . "experimental") }} _(experimental)_{{ end -}} +{{ end -}} + {{ range $_, $f := $data.funcs }} -## {{ if has $f "rawName" }}{{ $f.rawName }}{{ else }}`{{ $f.name }}`{{ if has $f "deprecated" }} _(deprecated)_ -**Deprecation Notice:** {{ $f.deprecated }}{{ end }}{{ end }} +## {{ if has $f "rawName" -}} +{{ $f.rawName }}{{ else }}`{{ $f.name }}`{{ end }}{{ template "annotations" $f }} +{{ if has $f "deprecated" -}} +**Deprecation Notice:** {{ $f.deprecated }} +{{ end -}} +{{ if and (has . "experimental") (index . "experimental") -}} +**Experimental:** This function is [_experimental_][experimental] and may be enabled with the [`--experimental`][experimental] flag. + +[experimental]: ../config/#experimental +{{ end -}} + {{ if has $f "alias" }} **Alias:** `{{$f.alias}}` {{ end }} |