[selinux-policy: 1963/3172] trunk: Add unused interface/template parameter metadata in XML.

Daniel J Walsh dwalsh at fedoraproject.org
Thu Oct 7 21:54:36 UTC 2010 

commit c5cfd2d40557a37769c4265cf6667f91e21096fc
Author: Chris PeBenito <cpebenito at tresys.com>
Date:   Tue Jun 24 14:23:40 2008 +0000

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

 Changelog                             |    1 +
 doc/policy.dtd                        |    3 ++-
 doc/templates/interface.html          |    6 ++----
 doc/templates/template.html           |    6 ++----
 policy/modules/services/cpucontrol.if |    2 +-
 policy/modules/services/dbus.if       |    4 ++--
 policy/modules/services/mta.if        |    2 +-
 policy/modules/services/ntp.if        |    2 +-
 policy/modules/services/postfix.if    |    7 ++++++-
 policy/modules/services/qmail.if      |    2 +-
 policy/modules/services/rhgb.if       |    2 +-
 policy/modules/services/rpc.if        |    2 +-
 policy/modules/services/sendmail.if   |    2 +-
 policy/modules/system/pcmcia.if       |    2 +-
 support/sedoctool.py                  |   14 ++++++++++++--
 15 files changed, 35 insertions(+), 22 deletions(-)
---
diff --git a/Changelog b/Changelog
index 1c51524..8289f4a 100644
--- a/Changelog
+++ b/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.
diff --git a/doc/policy.dtd b/doc/policy.dtd
index e6a4182..b797f71 100644
--- a/doc/policy.dtd
+++ b/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
diff --git a/doc/templates/interface.html b/doc/templates/interface.html
index ae7bf49..90eb436 100644
--- a/doc/templates/interface.html
+++ b/doc/templates/interface.html
@@ -35,15 +35,13 @@
 [[int['interface_desc']]]
 [[end]]
 <h5>Parameters</h5>
-<table border="1" cellspacing="0" cellpadding="3" width="80%">
-<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
+<table border="1" cellspacing="0" cellpadding="3" width="65%">
+<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>
diff --git a/doc/templates/template.html b/doc/templates/template.html
index c24a83e..251d227 100644
--- a/doc/templates/template.html
+++ b/doc/templates/template.html
@@ -35,15 +35,13 @@
 [[temp['template_desc']]]
 [[end]]
 <h5>Parameters</h5>
-<table border="1" cellspacing="0" cellpadding="3" width="80%">
-<tr><th >Parameter:</td><th >Description:</td><th >Optional:</td></tr>
+<table border="1" cellspacing="0" cellpadding="3" width="65%">
+<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>
diff --git a/policy/modules/services/cpucontrol.if b/policy/modules/services/cpucontrol.if
index a827592..d7b79e7 100644
--- a/policy/modules/services/cpucontrol.if
+++ b/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>
diff --git a/policy/modules/services/dbus.if b/policy/modules/services/dbus.if
index 1485fdd..f0d1847 100644
--- a/policy/modules/services/dbus.if
+++ b/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).
diff --git a/policy/modules/services/mta.if b/policy/modules/services/mta.if
index 9488fb0..b20fb95 100644
--- a/policy/modules/services/mta.if
+++ b/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>
diff --git a/policy/modules/services/ntp.if b/policy/modules/services/ntp.if
index ab5a15f..6330439 100644
--- a/policy/modules/services/ntp.if
+++ b/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>
diff --git a/policy/modules/services/postfix.if b/policy/modules/services/postfix.if
index 5cf7186..8ec787c 100644
--- a/policy/modules/services/postfix.if
+++ b/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(`
diff --git a/policy/modules/services/qmail.if b/policy/modules/services/qmail.if
index 4c90a54..e14d35e 100644
--- a/policy/modules/services/qmail.if
+++ b/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).
diff --git a/policy/modules/services/rhgb.if b/policy/modules/services/rhgb.if
index c859f23..c9711c6 100644
--- a/policy/modules/services/rhgb.if
+++ b/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>
diff --git a/policy/modules/services/rpc.if b/policy/modules/services/rpc.if
index afc5e81..294f0ad 100644
--- a/policy/modules/services/rpc.if
+++ b/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>
diff --git a/policy/modules/services/sendmail.if b/policy/modules/services/sendmail.if
index 4e176de..3e7077f 100644
--- a/policy/modules/services/sendmail.if
+++ b/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>
diff --git a/policy/modules/system/pcmcia.if b/policy/modules/system/pcmcia.if
index 4932c0b..b819b95 100644
--- a/policy/modules/system/pcmcia.if
+++ b/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>
diff --git a/support/sedoctool.py b/support/sedoctool.py
index f15a5b5..5bbaf76 100644
--- a/support/sedoctool.py
+++ b/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,

More information about the scm-commits mailing list