App::DocKnot

(Documentation and software release management)

Requirements | Description | Instance Methods | Author
Copyright and License | See Also

REQUIREMENTS

Perl 5.24 or later and the modules File::BaseDir, File::ShareDir, Kwalify, Path::Tiny, and YAML::XS, all of which are available from CPAN.

DESCRIPTION

DocKnot is a system for documentation and software release management. Its functionality is provided by various submodules, often invoked via the docknot command-line program. For more information, see docknot(1).

This module only provides helper functions to load configuration and metadata that are used by its various submodules.

INSTANCE METHODS

appdata_path(PATH[, ...])

Return the path of a file from the application data. The file is specified as one or more path components.

These data files are installed with App::DocKnot, but each file can be overridden by the user via files in $HOME/.config/docknot or /etc/xdg/docknot (or whatever $XDG_CONFIG_HOME and $XDG_CONFIG_DIRS are set to). Raises a text exception if the desired file could not be located.

load_yaml_file(PATH, SCHEMA)

Load a YAML file with schema checking. PATH is the path to the file. SCHEMA is the name of the schema, which will be loaded from the schema directory using appdata_path(). See the description of that method for the paths that are searched.

AUTHOR

Russ Allbery <rra@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2013-2022 Russ Allbery <rra@cpan.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

SEE ALSO

docknot(1)

This module is part of the App-DocKnot distribution. The current version of DocKnot is available from CPAN, or directly from its web site at <https://www.eyrie.org/~eagle/software/docknot/>.