PolicyKit: Branch 'master' - 2 commits

David Zeuthen david at kemper.freedesktop.org
Mon Aug 27 13:46:50 PDT 2007


 COPYING                               |   14 +-
 doc/polkit-docs.xml                   |  163 ++++++++++++++++++++++++++++++++++
 doc/spec/polkit-spec-introduction.xml |   26 +++--
 3 files changed, 186 insertions(+), 17 deletions(-)

New commits:
diff-tree ba0e33beeae7d066fc87359d31ac1517dd4c2385 (from 51dc397f6a3ce098dced0b3a18b59f968f533bc9)
Author: David Zeuthen <davidz at redhat.com>
Date:   Mon Aug 27 16:41:40 2007 -0400

    minor doc changes

diff --git a/COPYING b/COPYING
index 522d837..f1b4b52 100644
--- a/COPYING
+++ b/COPYING
@@ -1,16 +1,18 @@
 The PolicyKit command-line tools are licensed to you under the GNU
-General Public License version 2.
+General Public License either version 2 of the License, or (at your
+option) any later version.
 
-libpolkit is licensed to you under your choice of the Academic Free
-License version 2.1, or the GNU General Public License version 2.
+The PolicyKit libraries (libpolkit, libpolkit-grant, libpolkit-dbus)
+are licensed to you under your choice of the Academic Free License
+version 2.1, or the GNU General Public License either version 2 of the
+License, or (at your option) any later version.
 
-Both licenses are included here. Some individual source code files 
-and/or binaries may be under the GPL only or under the LGPL.
+Both licenses are included here. Some individual source code files
+and/or binaries may be under the GPL only.
 
 Each source code file is marked with the proper copyright information.
 
 
-
 The Academic Free License
 v. 2.1
 
diff --git a/doc/spec/polkit-spec-introduction.xml b/doc/spec/polkit-spec-introduction.xml
index ffb309b..9ec2c13 100644
--- a/doc/spec/polkit-spec-introduction.xml
+++ b/doc/spec/polkit-spec-introduction.xml
@@ -8,17 +8,18 @@
     <title>About</title>
     
     <para>
-      PolicyKit is a toolkit for defining and handling the policy that
-      allows unprivileged processes to speak to privileged processes:
-      It is a framework for centralizing the decision making process
-      with respect to granting access to privileged operations for
-      unprivileged applications. PolicyKit is specifically targeting
-      applications in rich desktop environments on multi-user
-      UNIX-like operating systems.
+      PolicyKit is an application-level toolkit for defining and
+      handling the policy that allows unprivileged processes to speak
+      to privileged processes: It is a framework for centralizing the
+      decision making process with respect to granting access to
+      privileged operations for unprivileged applications. PolicyKit
+      is specifically targeting applications in rich desktop
+      environments on multi-user UNIX-like operating systems. It does
+      not imply or rely on any exotic kernel features.
     </para>
   </sect1>
 
-  <sect1>
+  <sect1 id="polkit-spec-history">
     <title>History and Prior Art</title>
     
     <para>
@@ -60,7 +61,8 @@
     <title>Defining the Problem</title>
 
     <para>
-      There's a couple of problems with the status quo
+      There's a couple of problems with the mechanisms described in
+      <xref linkend="polkit-spec-history"/>.
 
       <itemizedlist>
         <listitem>
@@ -80,7 +82,7 @@
           <para>
             The way most people use pam-console and sudo is
             fundamentally broken. Full-fledged GTK+ or Qt applications
-            as the super user which means that millions of line of
+            run as the super user which means that millions of line of
             code (including code such as image loaders that
             historically have lots of security problems) runs
             privileged. This is in direct violation of the well-known
@@ -121,7 +123,9 @@
             Without a centralized framework, access control
             configuration is often scattered throughout the system
             which makes it hard for system administrators to grasp how
-            to configure the system.
+            to configure the system. There's literally a bunch of
+            different configuration files all with different formats
+            and semantics.
           </para>
         </listitem>
 
diff-tree 51dc397f6a3ce098dced0b3a18b59f968f533bc9 (from 292f230cddaf923def3ab757f04dfa39747269a8)
Author: David Zeuthen <davidz at redhat.com>
Date:   Mon Aug 27 16:39:59 2007 -0400

    also forgot to add polkit-docs.xml

diff --git a/doc/polkit-docs.xml b/doc/polkit-docs.xml
new file mode 100644
index 0000000..3a52efb
--- /dev/null
+++ b/doc/polkit-docs.xml
@@ -0,0 +1,163 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>PolicyKit Library Reference Manual</title>
+    <releaseinfo>Version &version;</releaseinfo>
+    <authorgroup>
+      <author>
+	<firstname>David</firstname>
+	<surname>Zeuthen</surname>
+	<affiliation>
+	  <address>
+	    <email>david at fubar.dk</email>
+	  </address>
+	</affiliation>
+      </author>
+    </authorgroup>
+
+    <copyright>
+      <year>2007</year>
+      <holder>The PolicyKit Authors</holder>
+    </copyright>
+
+    <legalnotice>
+      <para>
+	Permission is granted to copy, distribute and/or modify this
+	document under the terms of the <citetitle>GNU Free
+	Documentation License</citetitle>, Version 1.1 or any later
+	version published by the Free Software Foundation with no
+	Invariant Sections, no Front-Cover Texts, and no Back-Cover
+	Texts. You may obtain a copy of the <citetitle>GNU Free
+	Documentation License</citetitle> from the Free Software
+	Foundation by visiting <ulink type="http"
+	url="http://www.fsf.org">their Web site</ulink> or by writing
+	to:
+
+	<address>
+	  The Free Software Foundation, Inc.,
+	  <street>59 Temple Place</street> - Suite 330,
+	  <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
+	  <country>USA</country>
+	</address>
+      </para>
+
+      <para>
+	Many of the names used by companies to distinguish their
+	products and services are claimed as trademarks. Where those
+	names appear in any GNOME documentation, and those trademarks
+	are made aware to the members of the GNOME Documentation
+	Project, the names have been printed in caps or initial caps.
+      </para>
+    </legalnotice>
+  </bookinfo>
+
+  <reference>
+    <title>Design Overview</title>
+    <partintro>
+      <para>
+	This part presents the design documentation for PolicyKit.
+        <xi:include href="man/PolicyKit.xml"/>
+      </para>
+    </partintro>
+    <xi:include href="spec/polkit-spec-introduction.xml" />
+    <xi:include href="spec/polkit-spec-model.xml" />
+    <xi:include href="spec/polkit-spec-configuration.xml" />    
+  </reference>
+
+  <reference>
+    <title>Core API Reference</title>
+    <partintro>
+      <para>
+	This part presents the class and function reference for the
+	core PolicyKit library, <literal>libpolkit</literal>.
+      </para>
+    </partintro>
+    <xi:include href="xml/polkit-types.xml"/>
+    <xi:include href="xml/polkit-error.xml"/>
+    <xi:include href="xml/polkit-result.xml"/>
+    <xi:include href="xml/polkit-action.xml"/>
+    <xi:include href="xml/polkit-seat.xml"/>
+    <xi:include href="xml/polkit-session.xml"/>
+    <xi:include href="xml/polkit-caller.xml"/>
+    <xi:include href="xml/polkit-context.xml"/>
+    <xi:include href="xml/polkit-config.xml"/>
+    <xi:include href="xml/polkit-policy-file.xml"/>
+    <xi:include href="xml/polkit-policy-file-entry.xml"/>
+    <xi:include href="xml/polkit-policy-default.xml"/>
+    <xi:include href="xml/polkit-policy-cache.xml"/>
+  </reference>
+
+  <reference>
+    <title>Convenience API Reference</title>
+    <partintro>
+      <para>
+	This part presents the class and function reference for the
+	convenience library <literal>libpolkit-dbus</literal>.
+      </para>
+    </partintro>
+    <xi:include href="xml/polkit-dbus.xml"/>
+  </reference>
+
+  <reference>
+    <title>Authorization and privilege granting API Reference</title>
+    <partintro>
+      <para>
+	This part presents the class and function reference for the
+	PolicyKit granting library, libpolkit-grant. This library is
+	targetted at desktop developers writing authentication dialogs
+	that users can use to obtain privileges to do specific
+	actions.
+      </para>
+    </partintro>
+    <xi:include href="xml/polkit-grant.xml"/>
+  </reference>
+
+  <reference>
+    <title>Tools and file formats</title>
+    <partintro>
+      <para>
+	This part presents the tools, file formats used and assorted documentation distributed with PolicyKit.
+      </para>
+    </partintro>
+    <xi:include href="man/PolicyKit.xml"/>
+    <xi:include href="man/PolicyKit.conf.xml"/>
+    <xi:include href="man/polkit-grant.xml"/>
+    <xi:include href="man/polkit-list-actions.xml"/>
+    <xi:include href="man/polkit-policy-file-validate.xml"/>
+    <xi:include href="man/polkit-config-file-validate.xml"/>
+  </reference>
+
+  <index>
+    <title>Index</title>
+  </index>
+
+  <!-- License -->
+
+  <appendix id="license">
+    <title>License</title>
+    <para>
+      The PolicyKit command-line tools are licensed to you under the
+      GNU General Public License either version 2 of the License, or
+      (at your option) any later version.
+    </para>
+    <para>
+      The PolicyKit libraries (libpolkit, libpolkit-grant,
+      libpolkit-dbus) are licensed to you under your choice of the
+      Academic Free License version 2.1, or the GNU General Public
+      License either version 2 of the License, or (at your option) any
+      later version.
+    </para>
+    <para>
+      Both licenses are included here. Some individual source code
+      files and/or binaries may be under the GPL only.
+    </para>
+    <para>
+      Each source code file is marked with the proper copyright
+      information.
+    </para>
+  </appendix>
+</book>


More information about the hal-commit mailing list