docs: add cross-links between pages and other small updates

diff --git a/docs/building.xml b/docs/building.xml
index c0854c3..5bb8590 100644 (file)
--- a/docs/building.xml
+++ b/docs/building.xml
@@ -167,8 +167,9 @@
         <title><systemitem>--enable-keychain=sysctx</systemitem></title>
         
         <para>
-            Sets the system security context of keychain UI as returned by
-            the access control manager. This value becomes written to the
+            Sets the system security context of keychain UI process as returned by
+            the default <link linkend="GSignondAccessControlManager">
+            GSignondAccessControlManager</link>. This value becomes written to the
             gsignond.conf in addition to being encoded as default value
             through config.h.
         </para>
@@ -179,7 +180,9 @@
         
         <para>
             Sets the base path for user specific storage directories where
-            database files will be located.
+            database files will be located as utilised by 
+            <link linkend="GSignondStorageManager">
+            GSignondStorageManager</link>.
             Default location is <filename>/var/db</filename>
         </para>
     </formalpara>

diff --git a/include/gsignond/gsignond-config-general.h b/include/gsignond/gsignond-config-general.h
index 65e1650..4945f5c 100644 (file)
--- a/include/gsignond/gsignond-config-general.h
+++ b/include/gsignond/gsignond-config-general.h
@@ -69,7 +69,7 @@
  * Path provided by #GSignondStorageManager for storing user-specific
  * information, including secret and metadata databases.
  *
- * This is run-time value and any value read from configuration file
+ * This is a run-time value and any value read from configuration file
  * is overwritten.
  * 
  * Value provided by the default implementation: 
@@ -92,9 +92,11 @@
 /**
  * GSIGNOND_CONFIG_GENERAL_KEYCHAIN_SYSCTX:
  *
- * System security context of the keychain UI.
+ * System security context of the keychain UI process 
+ * (see #GSignondAccessControlManager).
  *
- * Default value can be defined through configure flag.
+ * Default value can be defined through configure --enable-keychain flag (see
+ * <link linkend="gsignond-building">Building gsignond</link>).
  */
 #define GSIGNOND_CONFIG_GENERAL_KEYCHAIN_SYSCTX GSIGNOND_CONFIG_GENERAL \
                                                 "/KeychainSystemContext"

diff --git a/src/common/gsignond-access-control-manager.c b/src/common/gsignond-access-control-manager.c
index 7b51953..b583151 100644 (file)
--- a/src/common/gsignond-access-control-manager.c
+++ b/src/common/gsignond-access-control-manager.c
@@ -452,9 +452,13 @@ gsignond_access_control_manager_acl_is_valid (
  * has a special management access to all stored identities and is able to
  * perform deletion of all identities from storage.
  * 
- * The default implementation returns a context either set in the
- * configuration, or if not set, a value specified through a configure
- * option. If gSSO was compiled
+ * The default implementation returns a context either set in #GSignondConfig, 
+ * or if not set, a value specified through a configure --enable-keychain
+ * option (see
+ * <link linkend="gsignond-building">Building gsignond</link>), or if that is not
+ * set either then an empty string "" is returned. 
+ * 
+ * If gSSO was compiled
  * with --enable-debug and SSO_KEYCHAIN_SYSCTX environment variable is set, then
  * the value of that variable is used to set the returned system context instead.
  *

diff --git a/src/common/gsignond-config.c b/src/common/gsignond-config.c
index 1a80063..bd9bc6b 100644 (file)
--- a/src/common/gsignond-config.c
+++ b/src/common/gsignond-config.c
@@ -44,15 +44,10 @@
  * #GSignondConfig holds configuration information as a set of keys and values
  * (integer or strings). The key names are defined in 
  * <link linkend="gsignond-General-configuration">general config keys</link>,
- * <link linkend="gsignond-Database-configuration">database config keys</link>, and
- * <link linkend="gsignond-DBus-configuration">DBus config keys</link>.
+ * and <link linkend="gsignond-DBus-configuration">DBus config keys</link>.
  * 
- * The configuration is discovered from these sources, in decreasing order of 
- * priority:
- * - environment variables, if gSSO has been compiled with --enable-debug switch.
- * See the specific keys documentation for the variable names.
- * - gSSO configuration file. See below for where the file is searched for.
- * - default values. See the documentation for specific keys for those.
+ * The configuration is retrieved from the gSSO configuration file. See below 
+ * for where the file is searched for.
  * 
  * <refsect1><title>Where the configuration file is searched for</title></refsect1>
  * 
@@ -68,8 +63,8 @@
  * <refsect1><title>Example configuration file</title></refsect1>
  * 
  * See example configuration file here:
- * <ulink url="http://code.google.com/p/accounts-sso/source/browse/gsignond.conf?repo=gsignond">
- * http://code.google.com/p/accounts-sso/source/browse/gsignond.conf?repo=gsignond</ulink>
+ * <ulink url="http://code.google.com/p/accounts-sso/source/browse/gsignond.conf.in?repo=gsignond">
+ * http://code.google.com/p/accounts-sso/source/browse/gsignond.conf.in?repo=gsignond</ulink>
  */
 
 /**

diff --git a/src/common/gsignond-storage-manager.c b/src/common/gsignond-storage-manager.c
index e565a15..d30a0b9 100644 (file)
--- a/src/common/gsignond-storage-manager.c
+++ b/src/common/gsignond-storage-manager.c
@@ -287,7 +287,7 @@ gsignond_storage_manager_init (GSignondStorageManager *self)
  * @self: object instance.
  *
  * Initialize encryption storage. This means making sure that the 
- * necessary directories exist and are accessible.
+ * necessary directories under #GSIGNOND_CONFIG_GENERAL_STORAGE_PATH exist and are accessible.
  *
  * Returns: success?
  */
@@ -334,7 +334,8 @@ gsignond_storage_manager_storage_is_initialized (GSignondStorageManager *self)
  * @self: object instance.
  *
  * Mounts an encrypted storage and returns the filesystem path of the storage
- * mount point. This path will be used to access the secret database via
+ * mount point. This path will be set in #GSignondConfig as 
+ * #GSIGNOND_CONFIG_GENERAL_SECURE_DIR and used to access the secret database via
  * #GSignondSecretStorage.
  * 
  * The default implemenation does nothing, and immediately returns the path for the