summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid Zeuthen <davidz@redhat.com>2012-05-21 11:30:24 -0400
committerDavid Zeuthen <davidz@redhat.com>2012-05-21 11:30:24 -0400
commitcc039fe06d0905732bfa12cb5dd245c5535185ad (patch)
treee2cca1dfd09964484fd3ba87b83b7dec81241246 /docs
parent6f550da889c9ad313c9944888c8a263ac5e4e0f2 (diff)
downloadpolkit-cc039fe06d0905732bfa12cb5dd245c5535185ad.tar.gz
docs: emphasize that registered functions may actually never be called
Signed-off-by: David Zeuthen <davidz@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/man/polkit.xml13
1 files changed, 11 insertions, 2 deletions
diff --git a/docs/man/polkit.xml b/docs/man/polkit.xml
index 2aa1da1..4fbc117 100644
--- a/docs/man/polkit.xml
+++ b/docs/man/polkit.xml
@@ -511,7 +511,7 @@ System Context | |
<para>
The <function>addRule()</function> method is used for adding a
- function that is called whenever an authorization check for
+ function that may be called whenever an authorization check for
<parameter>action</parameter>, <parameter>subject</parameter>
and <parameter>details</parameter> is performed. Functions are
called in the order they have been added until one of the
@@ -532,7 +532,7 @@ System Context | |
<para>
The <function>addAdminRule()</function> method is used for
- adding a function that is called whenever administrator
+ adding a function may be called whenever administrator
authentication is required. The function is used to specify what
identies may be used for administrator authentication for the
authorization check identified by <parameter>action</parameter>,
@@ -549,6 +549,15 @@ System Context | |
</para>
<para>
+ There is no guarantee that a function registered with
+ <function>addRule()</function> or
+ <function>addAdminRule()</function> is ever called - for example
+ an early rules file could register a function that always return
+ a value, hence ensuring that functions added later are never
+ called.
+ </para>
+
+ <para>
The <function>log()</function> method writes the given
<parameter>message</parameter> to the system logger. Log entries
are emitted using the <constant>LOG_AUTHPRIV</constant> flag