[TIPC] Add help text for TIPC configuration option
[linux-3.10.git] / net / tipc / Kconfig
1 #
2 # TIPC configuration
3 #
4
5 menu "TIPC Configuration (EXPERIMENTAL)"
6         depends on INET && EXPERIMENTAL
7
8 config TIPC
9         tristate "The TIPC Protocol (EXPERIMENTAL)"
10         ---help---
11           The Transparent Inter Process Communication (TIPC) protocol is
12           specially designed for intra cluster communication. This protocol
13           originates from Ericsson where it has been used in carrier grade
14           cluster applications for many years.
15         
16           For more information about TIPC, see http://tipc.sourceforge.net.
17
18           This protocol support is also available as a module ( = code which
19           can be inserted in and removed from the running kernel whenever you
20           want). The module will be called tipc. If you want to compile it
21           as a module, say M here and read <file:Documentation/modules.txt>.
22
23           If in doubt, say N.
24
25 config TIPC_ADVANCED
26         bool "TIPC: Advanced configuration"
27         depends on TIPC
28         default n
29         help
30           Saying Y here will open some advanced configuration
31           for TIPC. Most users do not need to bother, so if
32           unsure, just say N.
33
34 config TIPC_ZONES
35         int "Maximum number of zones in network"
36         depends on TIPC && TIPC_ADVANCED
37         default "3"
38         help
39          Max number of zones inside TIPC network. Max supported value 
40          is 255 zones, minimum is 1
41
42          Default is 3 zones in a network; setting this to higher
43          allows more zones but might use more memory.
44
45 config TIPC_CLUSTERS
46         int "Maximum number of clusters in a zone"
47         depends on TIPC && TIPC_ADVANCED
48         default "1"
49         help
50           ***Only 1 (one cluster in a zone) is supported by current code.
51           Any value set here will be overridden.***
52
53           (Max number of clusters inside TIPC zone. Max supported 
54           value is 4095 clusters, minimum is 1.
55
56           Default is 1; setting this to smaller value might save 
57           some memory, setting it to higher
58           allows more clusters and might consume more memory.)
59
60 config TIPC_NODES
61         int "Maximum number of nodes in cluster"
62         depends on TIPC && TIPC_ADVANCED
63         default "255"
64         help
65           Maximum number of nodes inside a TIPC cluster. Maximum 
66           supported value is 2047 nodes, minimum is 8. 
67
68           Setting this to a smaller value saves some memory, 
69           setting it to higher allows more nodes.
70
71 config TIPC_SLAVE_NODES
72         int "Maximum number of slave nodes in cluster"
73         depends on TIPC && TIPC_ADVANCED
74         default "0"
75         help
76           ***This capability is not supported by current code.***
77           
78           Maximum number of slave nodes inside a TIPC cluster. Maximum 
79           supported value is 2047 nodes, minimum is 0. 
80
81           Setting this to a smaller value saves some memory, 
82           setting it to higher allows more nodes.
83
84 config TIPC_PORTS
85         int "Maximum number of ports in a node"
86         depends on TIPC && TIPC_ADVANCED
87         default "8191"
88         help
89           Maximum number of ports within a node. Maximum 
90           supported value is 64535 nodes, minimum is 127. 
91
92           Setting this to a smaller value saves some memory, 
93           setting it to higher allows more ports.
94
95 config TIPC_LOG
96         int "Size of log buffer"
97         depends on TIPC && TIPC_ADVANCED
98         default 0
99         help
100           Size (in bytes) of TIPC's internal log buffer, which records the
101           occurrence of significant events.  Maximum supported value
102           is 32768 bytes, minimum is 0.
103
104           There is no need to enable the log buffer unless the node will be
105           managed remotely via TIPC.
106
107 config TIPC_DEBUG
108         bool "Enable debugging support"
109         depends on TIPC
110         default n
111         help
112           This will enable debugging of TIPC.
113
114           Only say Y here if you are having trouble with TIPC.  It will
115           enable the display of detailed information about what is going on.
116
117 endmenu