- infos = Information about the template plugin is in keys below
- infos/author = Author Name elekt.nosp@m.ra@l.nosp@m.ibele.nosp@m.ktra.nosp@m..org
- infos/licence = BSD
- infos/needs =
- infos/provides =
- infos/recommends =
- infos/placements = prerollback rollback postrollback getresolver pregetstorage getstorage postgetstorage setresolver presetstorage setstorage precommit commit postcommit
- infos/status = recommended productive maintained reviewed conformant compatible coverage specific unittest shelltest tested nodep libc configurable final preview memleak experimental difficult unfinished old nodoc concept orphan obsolete discouraged -1000000
- infos/metadata =
- infos/description = one-line description of template
Copy this template if you want to start a new plugin written in C.
Usage
You can use scripts/copy-template to automatically rename everything to your plugin name:
cd src/plugins
../../scripts/copy-template yourplugin
Then update the README.md of your newly created plugin:
- enter your full name+email in
infos/author
- make sure
status, placements, and other clauses conform to descriptions in doc/CONTRACT.ini
- update the one-line description above
- add your plugin in
src/plugins/README.md
- and rewrite the rest of this
README.md to give a great explanation of what your plugin does
Dependencies
None.
Examples
# Backup-and-Restore: user/tests/template
kdb set user/tests/template/key value
#> Create a new key user/tests/template/key with string "value"
kdb get /tests/template/key
#> value
Limitations
None.
