-
Notifications
You must be signed in to change notification settings - Fork 0
specs
A directory spec inside the nail has a special meaning. It should hold simple text files that represent bits of metadata about the nail, here's the list of all currently recognized files:
Should contain the URL.
Should list all the authors and contributers one per line in the form of Author Name <[email protected]>
Should contain the nail version. The format is currently not enforced, but please consider the following:
- https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Version (the upstream_version part)
- http://semver.org/
May contain the additional codename for the nail version.
Should contain the description of the nail. The first line should contain the short description, while the whole file is treated as the full description.
Should list all the files in the nail one per line, except these spec files.
Should list executable files inside the bin/ directory one per line. These files will be symlinked into your PATH upon the nail installation.
Should list all the runnable test files inside the test/ directory one per line. These files will be executed with make test command.
(Reserved for future use)
(Reserved for future use)
__NAILS_SPECS is a special global hash that holds some information about encountered nails:
- entries like
[example:version]will hold the versions of the nails - entries like
[example:path]will hold the directory paths of the nails
__NAILS_CURRENT is a special local hash that holds some information about the current nail:
-
[:name]will hold the name -
[:path]will hold the directory path -
[:version]will hold the version