From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

NAME

Config::Model::Annotation - Read and write configuration annotations

VERSION

version 1.208

SYNOPSIS

my $arw = Config::Model::Annotation
-> new (
config_class_name => $self->{root_class_name},
instance => $self ,
) ;
$arw->load;
$arw->save;

DESCRIPTION

This module provides an object that read and write annotations (a bit like comments) to and from a configuration tree.

Depending on the effective id of the process, the annotation will be saved in:

  • /var/lib/config-model/<model_name>-note.yml for root (EUID == 0)

  • ~/.config-model/<model_name>-note.yml for normal user (EUID > 0)

CONSTRUCTOR

Quite standard. The constructor is passed a Config::Model::Instance object.

METHODS

save()

Save annotations in a file (See DESCRIPTION)

load()

Loads annotations from a file (See DESCRIPTION)

AUTHOR

Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

Config::Model, Config::Model::Node, Config::Model::Loader, Config::Model::Searcher, Config::Model::Value,