trunk: Add unused interface/template parameter metadata in XML.

Changelog

@@ -1,3 +1,4 @@
+- Add unused interface/template parameter metadata in XML.
 - Patch to handle postfix data_directory from Vaclav Ovsik.
 - SE-Postgresql policy from KaiGai Kohei.
 - Patch for X.org dbus support from Martin Orr.

doc/policy.dtd

@@ -28,7 +28,8 @@
 <!ELEMENT param (summary)>
 <!ATTLIST param 
       name CDATA #REQUIRED
-      optional (true|false) "false">
+      optional (true|false) "false"
+      unused (true|false) "false">
 <!ELEMENT infoflow EMPTY>
 <!ATTLIST infoflow 
       type CDATA #REQUIRED

doc/templates/interface.html

@@ -35,15 +35,13 @@
 [[int['interface_desc']]]
 [[end]]
 <h5>Parameters</h5>
-<table border="1" cellspacing="0" cellpadding="3" width="80%">
+<table border="1" cellspacing="0" cellpadding="3" width="65%">
-<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
+<tr><th >Parameter:</th><th >Description:</th></tr>
 [[for arg in int['interface_parameters']]]
 <tr><td>
 [[arg['name']]]
 </td><td>
 [[arg['desc']]]
-</td><td>
-[[arg['optional']]]
 </td></tr>
 [[end]]
 </table>

doc/templates/template.html

@@ -35,15 +35,13 @@
 [[temp['template_desc']]]
 [[end]]
 <h5>Parameters</h5>
-<table border="1" cellspacing="0" cellpadding="3" width="80%">
+<table border="1" cellspacing="0" cellpadding="3" width="65%">
-<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
+<tr><th >Parameter:</th><th >Description:</th></tr>
 [[for arg in temp['template_parameters']]]
 <tr><td>
 [[arg['name']]]
 </td><td>
 [[arg['desc']]]
-</td><td>
-[[arg['optional']]]
 </td></tr>
 [[end]]
 </table>

policy/modules/services/cpucontrol.if

@@ -4,7 +4,7 @@
 ## <summary>
 ##	CPUcontrol stub interface.  No access allowed.
 ## </summary>
-## <param name="domain" optional="true">
+## <param name="domain" optional="true" unused="true">
 ##	<summary>
 ##	N/A
 ##	</summary>

policy/modules/services/dbus.if

@@ -4,7 +4,7 @@
 ## <summary>
 ##	DBUS stub interface.  No access allowed.
 ## </summary>
-## <param name="domain" optional="true">
+## <param name="domain" optional="true" unused="true">
 ##	<summary>
 ##	N/A
 ##	</summary>
@@ -236,7 +236,7 @@ template(`dbus_system_bus_client_template',`
 ##	is the prefix for user_t).
 ##	</summary>
 ## </param>
-## <param name="domain_prefix">
+## <param name="domain_prefix" unused="true">
 ##	<summary>
 ##	The prefix of the domain (e.g., user
 ##	is the prefix for user_t).

policy/modules/services/mta.if

@@ -4,7 +4,7 @@
 ## <summary>
 ##	MTA stub interface.  No access allowed.
 ## </summary>
-## <param name="domain" optional="true">
+## <param name="domain" optional="true" unused="true">
 ##	<summary>
 ##	N/A
 ##	</summary>

policy/modules/services/ntp.if

@@ -4,7 +4,7 @@
 ## <summary>
 ##	NTP stub interface.  No access allowed.
 ## </summary>
-## <param name="domain" optional="true">
+## <param name="domain" optional="true" unused="true">
 ##	<summary>
 ##	N/A
 ##	</summary>

policy/modules/services/postfix.if

@@ -165,7 +165,7 @@ template(`postfix_user_domain_template',`
 ## <summary>
 ##	The per role template for the postfix module.
 ## </summary>
-## <param name="prefix">
+## <param name="prefix" unused="true">
 ##	<summary>
 ##	The prefix of the user domain.
 ##	(e.g., user is the prefix of user_t)
@@ -176,6 +176,11 @@ template(`postfix_user_domain_template',`
 ##	User domain type.
 ##	</summary>
 ## </param>
+## <param name="user_role">
+##	<summary>
+##	User role
+##	</summary>
+## </param>
 #
 template(`postfix_per_role_template',`
 	gen_require(`

policy/modules/services/qmail.if

@@ -11,7 +11,7 @@
 ##      by policy writers.
 ##      </p>
 ## </desc>
-## <param name="userdomain_prefix">
+## <param name="userdomain_prefix" unused="true">
 ##      <summary>
 ##      The prefix of the user domain (e.g., user
 ##      is the prefix for user_t).

policy/modules/services/rhgb.if

@@ -4,7 +4,7 @@
 ## <summary>
 ##	RHGB stub interface.  No access allowed.
 ## </summary>
-## <param name="domain">
+## <param name="domain" unused="true">
 ##	<summary>
 ##	N/A
 ##	</summary>

policy/modules/services/rpc.if

@@ -4,7 +4,7 @@
 ## <summary>
 ##	RPC stub interface.  No access allowed.
 ## </summary>
-## <param name="domain" optional="true">
+## <param name="domain" optional="true" unused="true">
 ##	<summary>
 ##	N/A
 ##	</summary>

policy/modules/services/sendmail.if

@@ -4,7 +4,7 @@
 ## <summary>
 ##	Sendmail stub interface.  No access allowed.
 ## </summary>
-## <param name="domain" optional="true">
+## <param name="domain" optional="true" unused="true">
 ##	<summary>
 ##	N/A
 ##	</summary>

policy/modules/system/pcmcia.if

@@ -4,7 +4,7 @@
 ## <summary>
 ##	PCMCIA stub interface.  No access allowed.
 ## </summary>
-## <param name="domain" optional="true">
+## <param name="domain" optional="true" unused="true">
 ##	<summary>
 ##	N/A
 ##	</summary>

support/sedoctool.py

@@ -465,9 +465,14 @@ def gen_docs(doc, working_dir, templatedir):
 					paramopt = "Yes"
 				else:
 					paramopt = "No"
+				if args.getAttribute("unused") == "true":
+					paramunused = "Yes"
+				else:
+					paramunused = "No"
 				parameter = { "name" : paramname,
 					      "desc" : paramdesc,
-					      "optional" : paramopt }
+					      "optional" : paramopt,
+					      "unused" : paramunused }
 				interface_parameters.append(parameter)
 			interfaces.append( { "interface_name" : interface_name,
 					   "interface_summary" : interface_summary,
@@ -506,9 +511,14 @@ def gen_docs(doc, working_dir, templatedir):
 					paramopt = "Yes"
 				else:
 					paramopt = "No"
+				if args.getAttribute("unused") == "true":
+					paramunused = "Yes"
+				else:
+					paramunused = "No"
 				parameter = { "name" : paramname,
 					      "desc" : paramdesc,
-					      "optional" : paramopt }
+					      "optional" : paramopt,
+					      "unused": paramunused }
 				template_parameters.append(parameter)
 			templates.append( { "template_name" : template_name,
 					   "template_summary" : template_summary,