diff options
Diffstat (limited to 'doc/RegConfig.3')
| -rw-r--r-- | doc/RegConfig.3 | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/RegConfig.3 b/doc/RegConfig.3 index ef46ba5..7f99b8f 100644 --- a/doc/RegConfig.3 +++ b/doc/RegConfig.3 @@ -26,9 +26,9 @@ registered for. Must not be NULL. Contains the name of the package registering the embedded configuration as ASCII string. This means that this information is in UTF-8 too. Must not be NULL. -.AP "const Tcl_Config" *configuration in +.AP Tcl_Config *configuration in Refers to an array of Tcl_Config entries containing the information -embedded in the library. Must not be NULL. The end of the array +embedded in the binary library. Must not be NULL. The end of the array is signaled by either a key identical to NULL, or a key referring to the empty string. .AP "const char" *valEncoding in @@ -36,14 +36,15 @@ Contains the name of the encoding used to store the configuration values as ASCII string. This means that this information is in UTF-8 too. Must not be NULL. .BE + .SH DESCRIPTION .PP The function described here has its base in TIP 59 and provides extensions with support for the embedding of configuration -information into their library and the generation of a +information into their binary library and the generation of a Tcl-level interface for querying this information. .PP -To embed configuration information into their library an +To embed configuration information into their binary library an extension has to define a non-volatile array of Tcl_Config entries in one if its source files and then call \fBTcl_RegisterConfig\fR to register that information. @@ -80,7 +81,7 @@ create a namespace having the provided \fIpkgName\fR, if not yet existing. .IP (2) create the command \fBpkgconfig\fR in that namespace and link it to -the provided information so that the keys from \fIconfiguration\fR and +the provided information so that the keys from _configuration_ and their associated values can be retrieved through calls to \fBpkgconfig\fR. .PP @@ -101,11 +102,11 @@ The \fBTcl_Config\fR structure contains the following fields: .PP .CS typedef struct Tcl_Config { - const char *\fIkey\fR; - const char *\fIvalue\fR; -} \fBTcl_Config\fR; + const char* key; + const char* value; +} Tcl_Config; .CE .\" No cross references yet. .\" .SH "SEE ALSO" .SH KEYWORDS -embedding, configuration, library +embedding, configuration, binary library |