add tun and bool descriptions

This commit is contained in:
Chris PeBenito 2005-07-11 13:49:15 +00:00
parent 249d461f23
commit 4d7511ba57
4 changed files with 17 additions and 6 deletions

View File

@ -1,3 +1,4 @@
* Doc tool now creates pages for global Booleans and global tunables.
* Doc tool now links directly to the interface/template in the * Doc tool now links directly to the interface/template in the
module page when it is selected in the interface/template index. module page when it is selected in the interface/template index.
* Added support for layer summaries. * Added support for layer summaries.

View File

@ -2,7 +2,10 @@
[[for bool in booleans]] [[for bool in booleans]]
<div id="interfacesmall"> <div id="interfacesmall">
Name: [[bool['bool_name']]]<p/> <h4>[[bool['bool_name']]]</h4>
Default Value: [[bool['def_val']]]<p/> <p>Default Value: [[bool['def_val']]]</p>
[[if bool['desc']]]
<p>[[bool['desc']]]</p>
[[end]]
</div> </div>
[[end]] [[end]]

View File

@ -2,7 +2,10 @@
[[for tun in tunables]] [[for tun in tunables]]
<div id="interfacesmall"> <div id="interfacesmall">
Name: [[tun['tun_name']]]<p/> <h4>[[tun['tun_name']]]</h4>
Default Value: [[tun['def_val']]]<p/> <p>Default Value: [[tun['def_val']]]</p>
[[if tun['desc']]]
<p>[[tun['desc']]]</p>
[[end]]
</div> </div>
[[end]] [[end]]

View File

@ -565,8 +565,10 @@ def gen_docs(doc, working_dir, templatedir):
if tunable.parentNode.nodeName == "policy": if tunable.parentNode.nodeName == "policy":
tunable_name = tunable.getAttribute("name") tunable_name = tunable.getAttribute("name")
default_value = tunable.getAttribute("dftval") default_value = tunable.getAttribute("dftval")
description = format_html_desc(tunable)
global_tun_buf.append( { "tun_name" : tunable_name, global_tun_buf.append( { "tun_name" : tunable_name,
"def_val" : default_value } ) "def_val" : default_value,
"desc" : description } )
global_tun_buf.sort(tun_cmp) global_tun_buf.sort(tun_cmp)
global_tun_tpl = pyplate.Template(tunlistdata) global_tun_tpl = pyplate.Template(tunlistdata)
global_tun_buf = global_tun_tpl.execute_string({"tunables" : global_tun_buf}) global_tun_buf = global_tun_tpl.execute_string({"tunables" : global_tun_buf})
@ -587,8 +589,10 @@ def gen_docs(doc, working_dir, templatedir):
if boolean.parentNode.nodeName == "policy": if boolean.parentNode.nodeName == "policy":
bool_name = boolean.getAttribute("name") bool_name = boolean.getAttribute("name")
default_value = boolean.getAttribute("dftval") default_value = boolean.getAttribute("dftval")
description = format_html_desc(boolean)
global_bool_buf.append( { "bool_name" : bool_name, global_bool_buf.append( { "bool_name" : bool_name,
"def_val" : default_value } ) "def_val" : default_value,
"desc" : description } )
global_bool_buf.sort(bool_cmp) global_bool_buf.sort(bool_cmp)
global_bool_tpl = pyplate.Template(boollistdata) global_bool_tpl = pyplate.Template(boollistdata)
global_bool_buf = global_bool_tpl.execute_string({"booleans" : global_bool_buf}) global_bool_buf = global_bool_tpl.execute_string({"booleans" : global_bool_buf})