← Back to branch summary

~ubuntu-branches/ubuntu/utopic/critcl/utopic

« back to all changes in this revision

Viewing changes to doc/include/api_bconfig.inc

  • Committer: Package Import Robot
  • Author(s): Andrew Shadura
  • Date: 2013-05-11 00:08:06 UTC
  • Revision ID: package-import@ubuntu.com-20130511000806-7hq1zc3fnn0gat79
Tags: upstream-3.1.9
Import upstream version 3.1.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/include/api_bconfig.inc
 
1
 
 
2
This package provides four commands for the management of the
 
3
build configuration, i.e. the per-platform information about
 
4
compilers, linkers, and their commandline options.
 
5
 
 
6
[para] [emph NOTE] that these commands are irrelevant to anybody just
 
7
wishing to write a package using critcl for the C parts. They are
 
8
management commands which are only useful to the
 
9
[manpage {CriTcl Application}] or similar tools.
 
10
 
 
11
[list_begin definitions]
 
12
 
 
13
[comment ---------------------------------------------------------------------]
 
14
[call [cmd ::critcl::readconfig] [arg path]]
 
15
 
 
16
This command reads the build configuration file at [arg path] and
 
17
configures the package using the information for the currently set
 
18
target platform.
 
19
 
 
20
[comment ---------------------------------------------------------------------]
 
21
[call [cmd ::critcl::showconfig] [opt [arg chan]]]
 
22
 
 
23
This command converts the currently active build configuration into a
 
24
human-readable string and prints the result to the channel [arg chan].
 
25
 
 
26
If [arg chan] is not present the string is instead returned as the
 
27
result of the command.
 
28
 
 
29
[comment {
 
30
    As a package it would be IMHO better to have these command only
 
31
    return the necessary internal data, and have the application
 
32
    higher up do the formatting.
 
33
}]
 
34
 
 
35
 
 
36
[comment ---------------------------------------------------------------------]
 
37
[call [cmd ::critcl::showallconfig] [opt [arg chan]]]
 
38
 
 
39
This command converts the set of all known build configurations (from
 
40
the currently active build configuration file last set with
 
41
[cmd critcl::readconfig]) into a string and print the result to the
 
42
channel [arg chan].
 
43
 
 
44
If [arg chan] is not present the string is instead returned as the
 
45
result of the command.
 
46
 
 
47
 
 
48
[comment {
 
49
    As a package it would be IMHO better to have these command only
 
50
    return the necessary internal data, and have the application
 
51
    higher up do the formatting.
 
52
}]
 
53
 
 
54
 
 
55
[comment ---------------------------------------------------------------------]
 
56
[call [cmd ::critcl::chooseconfig] [arg target] [opt [arg nomatcherr]]]
 
57
 
 
58
This command takes a target identifier and matches it against all
 
59
known targets, returning a list containing all the matching ones. This
 
60
search is first done on an exact basis, and then via glob matching. If
 
61
no known target matches the argument the default is to return an empty
 
62
list. However, if the boolean [arg nomatcherr] is specified and set,
 
63
and error will be thrown instead, using [cmd critcl::error].
 
64
 
 
65
 
 
66
[comment ---------------------------------------------------------------------]
 
67
[call [cmd ::critcl::setconfig] [arg target]]
 
68
 
 
69
This command takes a target identifier and configures the package to
 
70
use all its settings.
 
71
 
 
72
[list_end]