diff options
author | Roger Leigh <rleigh@debian.org> | 2005-12-26 16:52:55 +0000 |
---|---|---|
committer | Roger Leigh <rleigh@debian.org> | 2005-12-26 16:52:55 +0000 |
commit | 458df93d3ddd6ddf9e55503e0c5d9a2234ccc6f4 (patch) | |
tree | 7d37b5bb8515047beb527d3e4c79051c72c8bafa /doc | |
parent | 97635a217afef3a436586283de353feb684909d6 (diff) | |
download | schroot-458df93d3ddd6ddf9e55503e0c5d9a2234ccc6f4.tar.gz |
Remove gtk-doc data.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/schroot/.cvsignore | 23 | ||||
-rw-r--r-- | doc/schroot/Makefile.am | 70 | ||||
-rw-r--r-- | doc/schroot/schroot-docs.sgml | 26 | ||||
-rw-r--r-- | doc/schroot/schroot-sections.txt | 343 | ||||
-rw-r--r-- | doc/schroot/schroot.types | 11 | ||||
-rw-r--r-- | doc/schroot/tmpl/.cvsignore | 1 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-auth-conv-tty.sgml | 40 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-auth-conv.sgml | 157 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-auth-message.sgml | 90 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-auth.sgml | 454 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-chroot-block-device.sgml | 60 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-chroot-lvm-snapshot.sgml | 80 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-chroot-plain.sgml | 55 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-chroot.sgml | 481 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-config.sgml | 172 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-error.sgml | 41 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-lock.sgml | 93 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-marshallers.sgml | 63 | ||||
-rw-r--r-- | doc/schroot/tmpl/sbuild-session.sgml | 201 | ||||
-rw-r--r-- | doc/schroot/tmpl/schroot-options.sgml | 68 |
20 files changed, 0 insertions, 2529 deletions
diff --git a/doc/schroot/.cvsignore b/doc/schroot/.cvsignore deleted file mode 100644 index e043e457..00000000 --- a/doc/schroot/.cvsignore +++ /dev/null @@ -1,23 +0,0 @@ -.deps -.libs -Makefile -Makefile.in -html -html-build.stamp -html.stamp -scan-build.stamp -schroot-decl-list.txt -schroot-decl.txt -schroot-overrides.txt -schroot-undocumented.txt -schroot-unused.txt -schroot.args -schroot.hierarchy -schroot.interfaces -schroot.prerequisites -schroot.signals -sgml-build.stamp -sgml.stamp -tmpl-build.stamp -tmpl.stamp -xml diff --git a/doc/schroot/Makefile.am b/doc/schroot/Makefile.am deleted file mode 100644 index 0077a3a5..00000000 --- a/doc/schroot/Makefile.am +++ /dev/null @@ -1,70 +0,0 @@ -# schroot Makefile template -# -# -# Copyright © 2004-2005 Roger Leigh <rleigh@debian.org> -# -# schroot is free software; you can redistribute it and/or modify it -# under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# schroot is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place, Suite 330, Boston, -# MA 02111-1307 USA -# -##################################################################### - -# The name of the module. -#DOC_MODULE=schroot - -# The top-level SGML file. -#DOC_MAIN_SGML_FILE=schroot-docs.sgml - -# Extra options to supply to gtkdoc-scan -#SCAN_OPTIONS= - -# The directory containing the source code. Relative to $(srcdir) -#DOC_SOURCE_DIR=../../schroot - -#HFILE_GLOB=$(top_srcdir)/schroot/*.h -#CFILE_GLOB=$(top_srcdir)/schroot/*.c - -# CFLAGS and LDFLAGS for compiling scan program. Only needed -# if $(DOC_MODULE).types is non-empty. -#INCLUDES = \ -# -std=c99 \ -# -I$(srcdir) \ -# -I$(top_srcdir) \ -# -I$(top_srcdir)/schroot \ -# -I$(top_builddir) \ -# -I$(top_builddir)/schroot \ -# $(SCHROOT_CFLAGS) - -#GTKDOC_LIBS = \ -# $(top_builddir)/schroot/libschroot.la - -# Extra options to supply to gtkdoc-mkdb -#MKDB_OPTIONS= - -# Images to copy into HTML directory -#HTML_IMAGES = - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE) -#content_files = - -# Extra options to supply to gtkdoc-fixref -#FIXXREF_OPTIONS=--extra-dir=$(srcdir)/../schroot/html - -#include $(top_srcdir)/scripts/gtk-doc.make - - -# Other files to distribute -#EXTRA_DIST += - -######################################################################## diff --git a/doc/schroot/schroot-docs.sgml b/doc/schroot/schroot-docs.sgml deleted file mode 100644 index 75c7e627..00000000 --- a/doc/schroot/schroot-docs.sgml +++ /dev/null @@ -1,26 +0,0 @@ -<?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"> -<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> - <bookinfo> - <title>Schroot Reference Manual</title> - </bookinfo> - - <chapter> - <title>GObject-derived classes</title> - <xi:include href="xml/sbuild-chroot.xml"/> - <xi:include href="xml/sbuild-chroot-plain.xml"/> - <xi:include href="xml/sbuild-chroot-block-device.xml"/> - <xi:include href="xml/sbuild-chroot-lvm-snapshot.xml"/> - <xi:include href="xml/sbuild-config.xml"/> - <xi:include href="xml/sbuild-auth.xml"/> - <xi:include href="xml/sbuild-auth-message.xml"/> - <xi:include href="xml/sbuild-auth-conv.xml"/> - <xi:include href="xml/sbuild-auth-conv-tty.xml"/> - <xi:include href="xml/sbuild-session.xml"/> - <xi:include href="xml/sbuild-marshallers.xml"/> - <xi:include href="xml/sbuild-error.xml"/> - <xi:include href="xml/sbuild-lock.xml"/> - <xi:include href="xml/schroot-options.xml"/> - </chapter> -</book> diff --git a/doc/schroot/schroot-sections.txt b/doc/schroot/schroot-sections.txt deleted file mode 100644 index 8bf1d7a8..00000000 --- a/doc/schroot/schroot-sections.txt +++ /dev/null @@ -1,343 +0,0 @@ -<SECTION> -<FILE>sbuild-chroot</FILE> -<TITLE>SbuildChroot</TITLE> -SbuildChroot -SbuildChrootClass -SbuildChrootPrintDetailsFunc -SbuildChrootGetChrootTypeFunc -SbuildChrootGetSessionFlagsFunc -SbuildChrootPrintConfigFunc -SbuildChrootSetupEnvFunc -SbuildChrootSetupLockFunc -SbuildChrootSessionFlags -SbuildChrootSetupType -SbuildChrootError -SBUILD_CHROOT_ERROR -sbuild_chroot_new -sbuild_chroot_new_from_keyfile -sbuild_chroot_set_properties_from_keyfile -sbuild_chroot_get_name -sbuild_chroot_set_name -sbuild_chroot_get_description -sbuild_chroot_set_description -sbuild_chroot_get_priority -sbuild_chroot_set_priority -sbuild_chroot_get_groups -sbuild_chroot_set_groups -sbuild_chroot_get_root_groups -sbuild_chroot_set_root_groups -sbuild_chroot_get_aliases -sbuild_chroot_set_aliases -sbuild_chroot_get_active -sbuild_chroot_set_active -sbuild_chroot_get_run_setup_scripts -sbuild_chroot_set_run_setup_scripts -sbuild_chroot_get_run_session_scripts -sbuild_chroot_set_run_session_scripts -sbuild_chroot_get_mount_location -sbuild_chroot_set_mount_location -sbuild_chroot_get_mount_device -sbuild_chroot_set_mount_device -sbuild_chroot_print_details -sbuild_chroot_print_config -sbuild_chroot_get_chroot_type -sbuild_chroot_get_session_flags -sbuild_chroot_setup_env -sbuild_chroot_setup_lock -<SUBSECTION Standard> -SBUILD_TYPE_CHROOT_ERROR -sbuild_chroot_error_get_type -sbuild_chroot_error_quark -SBUILD_TYPE_CHROOT_SETUP_TYPE -sbuild_chroot_setup_type_get_type -SBUILD_TYPE_CHROOT_SESSION_FLAGS -sbuild_chroot_session_flags_get_type -SBUILD_CHROOT -SBUILD_IS_CHROOT -SBUILD_TYPE_CHROOT -sbuild_chroot_get_type -SBUILD_CHROOT_CLASS -SBUILD_IS_CHROOT_CLASS -SBUILD_CHROOT_GET_CLASS -</SECTION> - -<SECTION> -<FILE>sbuild-chroot-plain</FILE> -<TITLE>SbuildChrootPlain</TITLE> -SbuildChrootPlain -SbuildChrootPlainClass -sbuild_chroot_plain_get_location -sbuild_chroot_plain_set_location -<SUBSECTION Standard> -SBUILD_TYPE_CHROOT_PLAIN -sbuild_chroot_plain_get_type -SBUILD_CHROOT_PLAIN -SBUILD_CHROOT_PLAIN_CLASS -SBUILD_CHROOT_PLAIN_GET_CLASS -SBUILD_IS_CHROOT_PLAIN -SBUILD_IS_CHROOT_PLAIN_CLASS -</SECTION> - -<SECTION> -<FILE>sbuild-chroot-block-device</FILE> -<TITLE>SbuildChrootBlockDevice</TITLE> -SbuildChrootBlockDevice -SbuildChrootBlockDeviceClass -sbuild_chroot_block_device_get_device -sbuild_chroot_block_device_set_device -<SUBSECTION Standard> -SBUILD_TYPE_CHROOT_BLOCK_DEVICE -sbuild_chroot_block_device_get_type -SBUILD_CHROOT_BLOCK_DEVICE -SBUILD_CHROOT_BLOCK_DEVICE_CLASS -SBUILD_CHROOT_BLOCK_DEVICE_GET_CLASS -SBUILD_IS_CHROOT_BLOCK_DEVICE -SBUILD_IS_CHROOT_BLOCK_DEVICE_CLASS -</SECTION> - -<SECTION> -<FILE>sbuild-chroot-lvm-snapshot</FILE> -<TITLE>SbuildChrootLvmSnapshot</TITLE> -SbuildChrootLvmSnapshot -SbuildChrootLvmSnapshotClass -sbuild_chroot_lvm_snapshot_get_snapshot_device -sbuild_chroot_lvm_snapshot_set_snapshot_device -sbuild_chroot_lvm_snapshot_get_snapshot_options -sbuild_chroot_lvm_snapshot_set_snapshot_options -<SUBSECTION Standard> -SBUILD_TYPE_CHROOT_LVM_SNAPSHOT -sbuild_chroot_lvm_snapshot_get_type -SBUILD_CHROOT_LVM_SNAPSHOT -SBUILD_CHROOT_LVM_SNAPSHOT_CLASS -SBUILD_CHROOT_LVM_SNAPSHOT_GET_CLASS -SBUILD_IS_CHROOT_LVM_SNAPSHOT -SBUILD_IS_CHROOT_LVM_SNAPSHOT_CLASS -</SECTION> - -<SECTION> -<FILE>sbuild-config</FILE> -<TITLE>SbuildConfig</TITLE> -SbuildConfig -SbuildConfigClass -SbuildConfigFileError -SBUILD_CONFIG_FILE_ERROR -sbuild_config_new -sbuild_config_new_from_file -sbuild_config_new_from_directory -sbuild_config_add_config_file -sbuild_config_add_config_directory -sbuild_config_get_chroots -sbuild_config_find_chroot -sbuild_config_find_alias -sbuild_config_get_chroot_list -sbuild_config_print_chroot_list -sbuild_config_print_chroot_info -sbuild_config_validate_chroots -<SUBSECTION Standard> -SBUILD_TYPE_CONFIG_FILE_ERROR -sbuild_config_file_error_get_type -sbuild_config_file_error_quark -SBUILD_CONFIG -SBUILD_IS_CONFIG -SBUILD_TYPE_CONFIG -sbuild_config_get_type -SBUILD_CONFIG_CLASS -SBUILD_IS_CONFIG_CLASS -SBUILD_CONFIG_GET_CLASS -</SECTION> - -<SECTION> -<FILE>sbuild-auth</FILE> -<TITLE>SbuildAuth</TITLE> -SbuildAuth -SbuildAuthRequireAuthFunc -SbuildAuthSessionRunFunc -SbuildAuthClass -SbuildAuthStatus -SbuildAuthVerbosity -SbuildAuthError -SBUILD_AUTH_ERROR -sbuild_auth_new -sbuild_auth_get_service -sbuild_auth_get_uid -sbuild_auth_get_gid -sbuild_auth_get_user -sbuild_auth_set_user -sbuild_auth_get_home -sbuild_auth_get_shell -sbuild_auth_get_command -sbuild_auth_set_command -sbuild_auth_get_environment -sbuild_auth_set_environment -sbuild_auth_get_pam_environment -sbuild_auth_get_ruid -sbuild_auth_get_ruser -sbuild_auth_get_verbosity -sbuild_auth_set_verbosity -sbuild_auth_get_conv -sbuild_auth_set_conv -sbuild_auth_start -sbuild_auth_stop -sbuild_auth_authenticate -sbuild_auth_account -sbuild_auth_cred_establish -sbuild_auth_cred_delete -sbuild_auth_open_session -sbuild_auth_close_session -sbuild_auth_setupenv -sbuild_auth_run -<SUBSECTION Standard> -SBUILD_TYPE_AUTH_ERROR -sbuild_auth_error_get_type -sbuild_auth_error_quark -SBUILD_TYPE_AUTH_STATUS -sbuild_auth_status_get_type -SBUILD_TYPE_AUTH_VERBOSITY -sbuild_auth_verbosity_get_type -SBUILD_AUTH -SBUILD_IS_AUTH -SBUILD_TYPE_AUTH -sbuild_auth_get_type -SBUILD_AUTH_CLASS -SBUILD_IS_AUTH_CLASS -SBUILD_AUTH_GET_CLASS -</SECTION> - -<SECTION> -<FILE>sbuild-auth-message</FILE> -<TITLE>SbuildAuthMessage</TITLE> -SbuildAuthMessage -SbuildAuthMessageVector -SbuildAuthMessageType -sbuild_auth_message_copy -sbuild_auth_message_free -sbuild_auth_message_vector_new -sbuild_auth_message_vector_copy -sbuild_auth_message_vector_free -<SUBSECTION Standard> -SBUILD_TYPE_AUTH_MESSAGE -sbuild_auth_message_get_type -SBUILD_TYPE_AUTH_MESSAGE_VECTOR -sbuild_auth_message_vector_get_type -SBUILD_TYPE_AUTH_MESSAGE_TYPE -sbuild_auth_message_type_get_type -</SECTION> - -<SECTION> -<FILE>sbuild-auth-conv</FILE> -<TITLE>SbuildAuthConv</TITLE> -SbuildAuthConv -SbuildAuthConvInterface -SbuildAuthConvGetWarningTimeoutFunc -SbuildAuthConvSetWarningTimeoutFunc -SbuildAuthConvGetFatalTimeoutFunc -SbuildAuthConvSetFatalTimeoutFunc -SbuildAuthConvConversationFunc -sbuild_auth_conv_get_warning_timeout -sbuild_auth_conv_set_warning_timeout -sbuild_auth_conv_get_fatal_timeout -sbuild_auth_conv_set_fatal_timeout -sbuild_auth_conv_conversation -<SUBSECTION Standard> -SBUILD_TYPE_AUTH_CONV -sbuild_auth_conv_get_type -SBUILD_AUTH_CONV -SBUILD_IS_AUTH_CONV -SBUILD_AUTH_CONV_GET_INTERFACE -</SECTION> - -<SECTION> -<FILE>sbuild-auth-conv-tty</FILE> -<TITLE>SbuildAuthConvTty</TITLE> -SbuildAuthConvTty -SbuildAuthConvTtyClass -sbuild_auth_conv_tty_new -<SUBSECTION Standard> -SBUILD_TYPE_AUTH_CONV_TTY -SBUILD_IS_AUTH_CONV_TTY -SBUILD_AUTH_CONV_TTY -sbuild_auth_conv_tty_get_type -SBUILD_AUTH_CONV_TTY_CLASS -SBUILD_IS_AUTH_CONV_TTY_CLASS -SBUILD_AUTH_CONV_TTY_GET_CLASS -</SECTION> - -<SECTION> -<FILE>sbuild-session</FILE> -<TITLE>SbuildSession</TITLE> -SbuildSession -SbuildSessionClass -SbuildSessionError -SbuildSessionOperation -SBUILD_SESSION_ERROR -sbuild_session_new -sbuild_session_get_config -sbuild_session_set_config -sbuild_session_get_operation -sbuild_session_set_operation -sbuild_session_get_session_id -sbuild_session_set_session_id -sbuild_session_get_force -sbuild_session_set_force -sbuild_session_get_chroots -sbuild_session_set_chroots -sbuild_session_get_child_status -<SUBSECTION Standard> -SBUILD_TYPE_SESSION_ERROR -sbuild_session_error_get_type -SBUILD_TYPE_SESSION_OPERATION -sbuild_session_operation_get_type -sbuild_session_error_quark -SBUILD_SESSION -SBUILD_IS_SESSION -SBUILD_TYPE_SESSION -sbuild_session_get_type -SBUILD_SESSION_CLASS -SBUILD_IS_SESSION_CLASS -SBUILD_SESSION_GET_CLASS -</SECTION> - -<SECTION> -<FILE>sbuild-marshallers</FILE> -<TITLE>Closure Marshallers</TITLE> -sbuild_cclosure_marshal_ENUM__VOID -sbuild_cclosure_marshal_BOOLEAN__BOXED -sbuild_cclosure_marshal_BOOLEAN__UINT_BOXED -</SECTION> - -<SECTION> -<FILE>sbuild-error</FILE> -<TITLE>Error handling</TITLE> -SbuildErrorPointer -SBUILD_TYPE_ERROR -SBUILD_TYPE_ERROR_POINTER -<SUBSECTION Standard> -sbuild_error_pointer_get_type -sbuild_error_get_type -</SECTION> - -<SECTION> -<FILE>sbuild-lock</FILE> -<TITLE>Advisory Locking</TITLE> -SBUILD_LOCK_ERROR -SbuildLockError -SbuildLockType -sbuild_lock_set_lock -sbuild_lock_unset_lock -sbuild_lock_set_device_lock -sbuild_lock_unset_device_lock -<SUBSECTION Standard> -SBUILD_TYPE_LOCK_ERROR -sbuild_lock_error_get_type -SBUILD_TYPE_LOCK_TYPE -sbuild_lock_type_get_type -</SECTION> - -<SECTION> -<FILE>schroot-options</FILE> -<TITLE>SchrootOptions</TITLE> -SchrootOptions -schroot_options_new -schroot_options_parse -schroot_options_free -</SECTION> diff --git a/doc/schroot/schroot.types b/doc/schroot/schroot.types deleted file mode 100644 index 25345f91..00000000 --- a/doc/schroot/schroot.types +++ /dev/null @@ -1,11 +0,0 @@ -#include "schroot.h" - -sbuild_auth_get_type -sbuild_auth_conv_get_type -sbuild_auth_conv_tty_get_type -sbuild_chroot_get_type -sbuild_chroot_plain_get_type -sbuild_chroot_block_device_get_type -sbuild_chroot_lvm_snapshot_get_type -sbuild_config_get_type -sbuild_session_get_type diff --git a/doc/schroot/tmpl/.cvsignore b/doc/schroot/tmpl/.cvsignore deleted file mode 100644 index d9de6f4e..00000000 --- a/doc/schroot/tmpl/.cvsignore +++ /dev/null @@ -1 +0,0 @@ -schroot-unused.sgml diff --git a/doc/schroot/tmpl/sbuild-auth-conv-tty.sgml b/doc/schroot/tmpl/sbuild-auth-conv-tty.sgml deleted file mode 100644 index e43c0598..00000000 --- a/doc/schroot/tmpl/sbuild-auth-conv-tty.sgml +++ /dev/null @@ -1,40 +0,0 @@ -<!-- ##### SECTION Title ##### --> - - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT SbuildAuthConvTty ##### --> -<para> -SbuildAuthConvTty object. -</para> - - -<!-- ##### STRUCT SbuildAuthConvTtyClass ##### --> -<para> -SbuildAuthConvTty class. -</para> - -@parent: the parent class - -<!-- ##### FUNCTION sbuild_auth_conv_tty_new ##### --> -<para> - -</para> - -@Returns: - - diff --git a/doc/schroot/tmpl/sbuild-auth-conv.sgml b/doc/schroot/tmpl/sbuild-auth-conv.sgml deleted file mode 100644 index c6a61048..00000000 --- a/doc/schroot/tmpl/sbuild-auth-conv.sgml +++ /dev/null @@ -1,157 +0,0 @@ -<!-- ##### SECTION Title ##### --> - - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT SbuildAuthConv ##### --> -<para> -SbuildAuthConv interface. -</para> - - -<!-- ##### SIGNAL SbuildAuthConv::conversation ##### --> -<para> -Hold a conversation with the user. Note that for security, only the -first registered signal handler will be run, so that the user will not -be asked for the same information by multiple handlers. -</para> - -@sbuildauthconv: the object which received the signal. -@arg1: the number of messages -@arg2: the message vector containing the messages and responses -@Returns: TRUE on success, FALSE on failure. - -<!-- ##### ARG SbuildAuthConv:fatal-timeout ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildAuthConv:warning-timeout ##### --> -<para> - -</para> - -<!-- ##### STRUCT SbuildAuthConvInterface ##### --> -<para> -SbuildAuthConv interface. -</para> - -@parent: parent GInterface -@get_warning_timeout: get the warning timeout -@set_warning_timeout: set the warning timeout -@get_fatal_timeout: get the fatal timeout -@set_fatal_timeout: set the fatal timeout -@conversation: hold a conversation with the user - -<!-- ##### USER_FUNCTION SbuildAuthConvGetWarningTimeoutFunc ##### --> -<para> -Get the warning timeout. -</para> - -@auth_conv: an #SbuildAuthConv. -@Returns: the warning timeout. - - -<!-- ##### USER_FUNCTION SbuildAuthConvSetWarningTimeoutFunc ##### --> -<para> -Set the warning timeout. -</para> - -@auth_conv: an #SbuildAuthConv. -@timeout: the timeout to set. - - -<!-- ##### USER_FUNCTION SbuildAuthConvGetFatalTimeoutFunc ##### --> -<para> -Get the fatal timeout. -</para> - -@auth_conv: an #SbuildAuthConv. -@Returns: the fatal timeout. - - -<!-- ##### USER_FUNCTION SbuildAuthConvSetFatalTimeoutFunc ##### --> -<para> -Set the fatal timeout. -</para> - -@auth_conv: An #SbuildAuthConv. -@timeout: the timeout to set. - - -<!-- ##### USER_FUNCTION SbuildAuthConvConversationFunc ##### --> -<para> -Hold a conversation with the user. -</para> - -@auth_conv: An #SbuildAuthConv. -@num_messages: the number of messages. -@messages: the messages. -@Returns: TRUE on success, FALSE on failure. - - -<!-- ##### FUNCTION sbuild_auth_conv_get_warning_timeout ##### --> -<para> - -</para> - -@auth_conv: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_conv_set_warning_timeout ##### --> -<para> - -</para> - -@auth_conv: -@timeout: -<!-- # Unused Parameters # --> -@time: - - -<!-- ##### FUNCTION sbuild_auth_conv_get_fatal_timeout ##### --> -<para> - -</para> - -@auth_conv: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_conv_set_fatal_timeout ##### --> -<para> - -</para> - -@auth_conv: -@timeout: -<!-- # Unused Parameters # --> -@time: - - -<!-- ##### FUNCTION sbuild_auth_conv_conversation ##### --> -<para> - -</para> - -@auth_conv: -@num_messages: -@messages: -@Returns: - - diff --git a/doc/schroot/tmpl/sbuild-auth-message.sgml b/doc/schroot/tmpl/sbuild-auth-message.sgml deleted file mode 100644 index 246d452f..00000000 --- a/doc/schroot/tmpl/sbuild-auth-message.sgml +++ /dev/null @@ -1,90 +0,0 @@ -<!-- ##### SECTION Title ##### --> - - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT SbuildAuthMessage ##### --> -<para> -SBuildAuth message structure. -</para> - -@type: the type of message. -@message: the message to display or use as a prompt. -@response: the response (if any) to return. -@user_data: #SbuildAuthConv implementation-dependent data. - -<!-- ##### STRUCT SbuildAuthMessageVector ##### --> -<para> -A vector of #SbuildAuthMessage structures. -</para> - -@refcount: the reference count. -@messages: a vector of #SbuildAuthMessage structures. - -<!-- ##### ENUM SbuildAuthMessageType ##### --> -<para> -The type of message. -</para> - -@SBUILD_AUTH_MESSAGE_PROMPT_NOECHO: Prompt for input, but don't echo. -@SBUILD_AUTH_MESSAGE_PROMPT_ECHO: Prompt for input, and echo. -@SBUILD_AUTH_MESSAGE_ERROR: Display an error message. -@SBUILD_AUTH_MESSAGE_INFO: Display an informational message. - -<!-- ##### FUNCTION sbuild_auth_message_copy ##### --> -<para> - -</para> - -@message: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_message_free ##### --> -<para> - -</para> - -@message: - - -<!-- ##### FUNCTION sbuild_auth_message_vector_new ##### --> -<para> - -</para> - -@size: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_message_vector_copy ##### --> -<para> - -</para> - -@messagev: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_message_vector_free ##### --> -<para> - -</para> - -@messagev: - - diff --git a/doc/schroot/tmpl/sbuild-auth.sgml b/doc/schroot/tmpl/sbuild-auth.sgml deleted file mode 100644 index 3ed1df10..00000000 --- a/doc/schroot/tmpl/sbuild-auth.sgml +++ /dev/null @@ -1,454 +0,0 @@ -<!-- ##### SECTION Title ##### --> - - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT SbuildAuth ##### --> -<para> -SbuildAuth object. -</para> - - -<!-- ##### SIGNAL SbuildAuth::require-auth ##### --> -<para> -Check if authentication is required. Each registered handler is run -in turn until all have run, or one returns SBUILD_AUTH_STATUS_FAIL. -</para> - -@sbuildauth: the object which received the signal. -@Returns: An SbuildAuthStatus to indicate whether authentication is -not required, required, or if it has already failed. - -<!-- ##### SIGNAL SbuildAuth::session-run ##### --> -<para> -Run a session. Each registered session handler is run in turn. -</para> - -@sbuildauth: the object which received the signal. -@arg1: A GError. -@Returns: TRUE to continue running session handlers, FALSE to abort on -error (@error must be set appropriately). - -<!-- ##### ARG SbuildAuth:command ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildAuth:conv ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildAuth:environment ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildAuth:gid ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildAuth:home ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildAuth:ruid ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildAuth:ruser ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildAuth:service ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildAuth:shell ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildAuth:uid ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildAuth:user ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildAuth:verbosity ##### --> -<para> - -</para> - -<!-- ##### USER_FUNCTION SbuildAuthRequireAuthFunc ##### --> -<para> -The function prototype required for use with the require_auth virtual -function. -</para> - -@auth: an #SbuildAuth -@Returns: An SbuildAuthStatus to indicate whether authentication is -not required, required, or if it has already failed. - - -<!-- ##### USER_FUNCTION SbuildAuthSessionRunFunc ##### --> -<para> -The function prototype required for use with the session_run virtual -function. -</para> - -@auth: an #SbuildAuth -@error: a #GError -@Returns: TRUE to continue running session handlers, FALSE to abort on -error (@error must be set appropriately). - - -<!-- ##### STRUCT SbuildAuthClass ##### --> -<para> -SbuildAuth class. -</para> - -@parent: the parent class -@require_auth: vfunc to check if authentication is required -@session_run: vfunc to run a session - -<!-- ##### ENUM SbuildAuthStatus ##### --> -<para> -The status of the authentication process. -</para> - -@SBUILD_AUTH_STATUS_NONE: No authentication is required. -@SBUILD_AUTH_STATUS_USER: User authentication is required. -@SBUILD_AUTH_STATUS_FAIL: Authentication has failed. - -<!-- ##### ENUM SbuildAuthVerbosity ##### --> -<para> -The verbosity level of printed messages. -</para> - -@SBUILD_AUTH_VERBOSITY_QUIET: Only print errors and warnings. -@SBUILD_AUTH_VERBOSITY_NORMAL: Print errors, warnings and important messages. -@SBUILD_AUTH_VERBOSITY_VERBOSE: Print everything. - -<!-- ##### ENUM SbuildAuthError ##### --> -<para> -The errors which can occur while loading a configuration file. -</para> - -@SBUILD_AUTH_ERROR_PAM_STARTUP: PAM startup failed. -@SBUILD_AUTH_ERROR_PAM_SET_ITEM: PAM failed to set a configuration item. -@SBUILD_AUTH_ERROR_HOSTNAME: The system hostname could not be resolved. -@SBUILD_AUTH_ERROR_PAM_AUTHENTICATE: PAM user authentication failed. -@SBUILD_AUTH_ERROR_PAM_PUTENV: PAM failed to set an environment variable. -@SBUILD_AUTH_ERROR_PAM_ACCOUNT: PAM user authorisation failed. -@SBUILD_AUTH_ERROR_PAM_CREDENTIALS: PAM failed to establish the user's credentials. -@SBUILD_AUTH_ERROR_PAM_SESSION_OPEN: PAM failed to open a session. -@SBUILD_AUTH_ERROR_PAM_SESSION_CLOSE: PAM failed to close a session. -@SBUILD_AUTH_ERROR_PAM_DELETE_CREDENTIALS: PAM failed to delete the user's credentials. -@SBUILD_AUTH_ERROR_PAM_SHUTDOWN: PAM shutdown failed. - -<!-- ##### MACRO SBUILD_AUTH_ERROR ##### --> -<para> -The error domain for sbuild authentication errors. -</para> - - - -<!-- ##### FUNCTION sbuild_auth_new ##### --> -<para> - -</para> - -@Returns: -<!-- # Unused Parameters # --> -@config: -@chroots: - - -<!-- ##### FUNCTION sbuild_auth_get_service ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_get_uid ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_get_gid ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_get_user ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_set_user ##### --> -<para> - -</para> - -@auth: -@user: - - -<!-- ##### FUNCTION sbuild_auth_get_home ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_get_shell ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_get_command ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_set_command ##### --> -<para> - -</para> - -@auth: -@command: - - -<!-- ##### FUNCTION sbuild_auth_get_environment ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_set_environment ##### --> -<para> - -</para> - -@auth: -@environment: - - -<!-- ##### FUNCTION sbuild_auth_get_pam_environment ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_get_ruid ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_get_ruser ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_get_verbosity ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_set_verbosity ##### --> -<para> - -</para> - -@auth: -@verbosity: - - -<!-- ##### FUNCTION sbuild_auth_get_conv ##### --> -<para> - -</para> - -@auth: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_set_conv ##### --> -<para> - -</para> - -@auth: -@conv: - - -<!-- ##### FUNCTION sbuild_auth_start ##### --> -<para> - -</para> - -@auth: -@error: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_stop ##### --> -<para> - -</para> - -@auth: -@error: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_authenticate ##### --> -<para> - -</para> - -@auth: -@error: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_account ##### --> -<para> - -</para> - -@auth: -@error: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_cred_establish ##### --> -<para> - -</para> - -@auth: -@error: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_cred_delete ##### --> -<para> - -</para> - -@auth: -@error: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_open_session ##### --> -<para> - -</para> - -@auth: -@error: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_close_session ##### --> -<para> - -</para> - -@auth: -@error: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_setupenv ##### --> -<para> - -</para> - -@auth: -@error: -@Returns: - - -<!-- ##### FUNCTION sbuild_auth_run ##### --> -<para> - -</para> - -@auth: -@error: -@Returns: -<!-- # Unused Parameters # --> -@child_status: - - diff --git a/doc/schroot/tmpl/sbuild-chroot-block-device.sgml b/doc/schroot/tmpl/sbuild-chroot-block-device.sgml deleted file mode 100644 index c2a8a624..00000000 --- a/doc/schroot/tmpl/sbuild-chroot-block-device.sgml +++ /dev/null @@ -1,60 +0,0 @@ -<!-- ##### SECTION Title ##### --> - - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT SbuildChrootBlockDevice ##### --> -<para> -SbuildChrootBlockDevice object. -</para> - - -<!-- ##### ARG SbuildChrootBlockDevice:device ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildChrootBlockDevice:mount-options ##### --> -<para> - -</para> - -<!-- ##### STRUCT SbuildChrootBlockDeviceClass ##### --> -<para> -SbuildChrootBlockDevice class. -</para> - -@parent: the parent class - -<!-- ##### FUNCTION sbuild_chroot_block_device_get_device ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_block_device_set_device ##### --> -<para> - -</para> - -@chroot: -@device: - - diff --git a/doc/schroot/tmpl/sbuild-chroot-lvm-snapshot.sgml b/doc/schroot/tmpl/sbuild-chroot-lvm-snapshot.sgml deleted file mode 100644 index 69494140..00000000 --- a/doc/schroot/tmpl/sbuild-chroot-lvm-snapshot.sgml +++ /dev/null @@ -1,80 +0,0 @@ -<!-- ##### SECTION Title ##### --> - - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT SbuildChrootLvmSnapshot ##### --> -<para> -SbuildChrootLvmSnapshot object. -</para> - - -<!-- ##### ARG SbuildChrootLvmSnapshot:lvm-snapshot-device ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildChrootLvmSnapshot:lvm-snapshot-options ##### --> -<para> - -</para> - -<!-- ##### STRUCT SbuildChrootLvmSnapshotClass ##### --> -<para> -SbuildChrootLvmSnapshot class. -</para> - -@parent: the parent class - -<!-- ##### FUNCTION sbuild_chroot_lvm_snapshot_get_snapshot_device ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_lvm_snapshot_set_snapshot_device ##### --> -<para> - -</para> - -@chroot: -@snapshot_device: - - -<!-- ##### FUNCTION sbuild_chroot_lvm_snapshot_get_snapshot_options ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_lvm_snapshot_set_snapshot_options ##### --> -<para> - -</para> - -@chroot: -@snapshot_options: -<!-- # Unused Parameters # --> -@device: - - diff --git a/doc/schroot/tmpl/sbuild-chroot-plain.sgml b/doc/schroot/tmpl/sbuild-chroot-plain.sgml deleted file mode 100644 index 988d129e..00000000 --- a/doc/schroot/tmpl/sbuild-chroot-plain.sgml +++ /dev/null @@ -1,55 +0,0 @@ -<!-- ##### SECTION Title ##### --> - - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT SbuildChrootPlain ##### --> -<para> -SbuildChrootPlain object. -</para> - - -<!-- ##### ARG SbuildChrootPlain:location ##### --> -<para> - -</para> - -<!-- ##### STRUCT SbuildChrootPlainClass ##### --> -<para> -SbuildChrootPlain class. -</para> - -@parent: the parent class - -<!-- ##### FUNCTION sbuild_chroot_plain_get_location ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_plain_set_location ##### --> -<para> - -</para> - -@chroot: -@location: - - diff --git a/doc/schroot/tmpl/sbuild-chroot.sgml b/doc/schroot/tmpl/sbuild-chroot.sgml deleted file mode 100644 index 000b77b0..00000000 --- a/doc/schroot/tmpl/sbuild-chroot.sgml +++ /dev/null @@ -1,481 +0,0 @@ -<!-- ##### SECTION Title ##### --> - - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT SbuildChroot ##### --> -<para> -SbuildChroot object. -</para> - - -<!-- ##### ARG SbuildChroot:active ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildChroot:aliases ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildChroot:description ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildChroot:groups ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildChroot:mount-device ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildChroot:mount-location ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildChroot:name ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildChroot:priority ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildChroot:root-groups ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildChroot:run-session-scripts ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildChroot:run-setup-scripts ##### --> -<para> - -</para> - -<!-- ##### STRUCT SbuildChrootClass ##### --> -<para> -SbuildChroot class. -</para> - -@parent: the parent class -@print_details: vfunc to print additional chroot details -@print_config: vfunc to print the config file group for this chroot -@setup_env: vfunc to set the environment that the setup scripts will see during execution -@get_chroot_type: vfunc to get the user visible chroot type name -@setup_lock: vfunc to lock a chroot during setup -@get_session_flags: vfunc to get the session flags for this chroot type - -<!-- ##### USER_FUNCTION SbuildChrootPrintDetailsFunc ##### --> -<para> -Print detailed information about @chroot to @file. The information -is printed in plain text with one line per property. This should -print additional detail in derived #SbuildChroot classes. -</para> - -@chroot: an #SbuildChroot -@file: the file to output to. - - -<!-- ##### USER_FUNCTION SbuildChrootGetChrootTypeFunc ##### --> -<para> -This function is used to get the name of the chroot type subclassed -from this type. This is a user-friendly form of the registered type -name of the class, for use in messages and configuration files. -</para> - -@chroot: an #SbuildChroot -@Returns: the type name - - -<!-- ##### USER_FUNCTION SbuildChrootGetSessionFlagsFunc ##### --> -<para> -This function is used to get the session flags of the chroot. These -determine how the #SbuildSession controlling the chroot will operate. -</para> - -@chroot: an #SbuildChroot -@Returns: the #SbuildChrootSessionFlags - - -<!-- ##### USER_FUNCTION SbuildChrootPrintConfigFunc ##### --> -<para> -Print the configuration group for a chroot in the format required -by schroot.conf. -</para> - -@chroot: an #SbuildChroot. -@file: the file to output to. - - -<!-- ##### USER_FUNCTION SbuildChrootSetupEnvFunc ##### --> -<para> -This function is used to set the environment that the setup scripts -will see during execution. Environment variables should be added to -@env as "key=value" strings (the format expected by execve envp). -These strings should be allocated with g_free (or related allocation -functions such as g_strdup), and they must not be freed. -</para> - -@chroot: an #SbuildChroot. -@env: the environment to set. - - -<!-- ##### USER_FUNCTION SbuildChrootSetupLockFunc ##### --> -<para> -Lock a chroot during setup. The locking technique (if any) may vary -depending upon the chroot type and setup stage. For example, during -creation a block device might require locking, but afterwards this -will change to the new block device or directory. -</para> - -@chroot: an #SbuildChroot. -@type: the type of setup being performed -@lock: TRUE to lock, FALSE to unlock -@error: a #GError -@Returns: TRUE on success, FALSE on failure - - -<!-- ##### ENUM SbuildChrootSessionFlags ##### --> -<para> -The session options for a given chroot type -</para> - -@SBUILD_CHROOT_SESSION_CREATE: The session persists once schroot -terminates, so a session file must be created. - -<!-- ##### ENUM SbuildChrootSetupType ##### --> -<para> -The type of chroot setup operation -</para> - -@SBUILD_CHROOT_SETUP_START: Set up a new chroot, preparing it for use -@SBUILD_CHROOT_SETUP_RECOVER: Recover an existing, but inactive, chroot -@SBUILD_CHROOT_SETUP_STOP: Clean up an existing chroot, possibly deleting it -@SBUILD_CHROOT_RUN_START: Start running a command in an existing chroot -@SBUILD_CHROOT_RUN_STOP: Stop running a command in an existing chroot - -<!-- ##### ENUM SbuildChrootError ##### --> -<para> -The errors which can occur during chroot operations. -</para> - -@SBUILD_CHROOT_ERROR_LOCK: A locking operation failed. - -<!-- ##### MACRO SBUILD_CHROOT_ERROR ##### --> -<para> -The error domain for sbuild chroot errors. -</para> - - - -<!-- ##### FUNCTION sbuild_chroot_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_new_from_keyfile ##### --> -<para> - -</para> - -@keyfile: -@group: -@Returns: -<!-- # Unused Parameters # --> -@active: - - -<!-- ##### FUNCTION sbuild_chroot_set_properties_from_keyfile ##### --> -<para> - -</para> - -@chroot: -@keyfile: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_get_name ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_set_name ##### --> -<para> - -</para> - -@chroot: -@name: - - -<!-- ##### FUNCTION sbuild_chroot_get_description ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_set_description ##### --> -<para> - -</para> - -@chroot: -@description: - - -<!-- ##### FUNCTION sbuild_chroot_get_priority ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_set_priority ##### --> -<para> - -</para> - -@chroot: -@priority: - - -<!-- ##### FUNCTION sbuild_chroot_get_groups ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_set_groups ##### --> -<para> - -</para> - -@chroot: -@groups: - - -<!-- ##### FUNCTION sbuild_chroot_get_root_groups ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_set_root_groups ##### --> -<para> - -</para> - -@chroot: -@groups: - - -<!-- ##### FUNCTION sbuild_chroot_get_aliases ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_set_aliases ##### --> -<para> - -</para> - -@chroot: -@aliases: - - -<!-- ##### FUNCTION sbuild_chroot_get_active ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_set_active ##### --> -<para> - -</para> - -@chroot: -@active: - - -<!-- ##### FUNCTION sbuild_chroot_get_run_setup_scripts ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_set_run_setup_scripts ##### --> -<para> - -</para> - -@chroot: -@run_setup_scripts: - - -<!-- ##### FUNCTION sbuild_chroot_get_run_session_scripts ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_set_run_session_scripts ##### --> -<para> - -</para> - -@chroot: -@run_session_scripts: - - -<!-- ##### FUNCTION sbuild_chroot_get_mount_location ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_set_mount_location ##### --> -<para> - -</para> - -@chroot: -@location: - - -<!-- ##### FUNCTION sbuild_chroot_get_mount_device ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_set_mount_device ##### --> -<para> - -</para> - -@chroot: -@device: - - -<!-- ##### FUNCTION sbuild_chroot_print_details ##### --> -<para> - -</para> - -@chroot: -@file: - - -<!-- ##### FUNCTION sbuild_chroot_print_config ##### --> -<para> - -</para> - -@chroot: -@file: - - -<!-- ##### FUNCTION sbuild_chroot_get_chroot_type ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_get_session_flags ##### --> -<para> - -</para> - -@chroot: -@Returns: - - -<!-- ##### FUNCTION sbuild_chroot_setup_env ##### --> -<para> - -</para> - -@chroot: -@env: - - -<!-- ##### FUNCTION sbuild_chroot_setup_lock ##### --> -<para> - -</para> - -@chroot: -@type: -@lock: -@error: -@Returns: - - diff --git a/doc/schroot/tmpl/sbuild-config.sgml b/doc/schroot/tmpl/sbuild-config.sgml deleted file mode 100644 index b8a3f520..00000000 --- a/doc/schroot/tmpl/sbuild-config.sgml +++ /dev/null @@ -1,172 +0,0 @@ -<!-- ##### SECTION Title ##### --> - - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT SbuildConfig ##### --> -<para> -SbuildConfig object. -</para> - - -<!-- ##### ARG SbuildConfig:config-directory ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildConfig:config-file ##### --> -<para> - -</para> - -<!-- ##### STRUCT SbuildConfigClass ##### --> -<para> -SbuildConfig class. -</para> - -@parent: the parent class - -<!-- ##### ENUM SbuildConfigFileError ##### --> -<para> -The errors which can occur while loading a configuration file. -</para> - -@SBUILD_CONFIG_FILE_ERROR_STAT_FAIL: The file could not be fstat()ed -@SBUILD_CONFIG_FILE_ERROR_OWNERSHIP: Ownership checks failed -@SBUILD_CONFIG_FILE_ERROR_PERMISSIONS: Permissions checks failed -@SBUILD_CONFIG_FILE_ERROR_NOT_REGULAR: Not a regular file - -<!-- ##### MACRO SBUILD_CONFIG_FILE_ERROR ##### --> -<para> -The error domain for sbuild configuration file errors. -</para> - - - -<!-- ##### FUNCTION sbuild_config_new ##### --> -<para> - -</para> - -@Returns: -<!-- # Unused Parameters # --> -@file: - - -<!-- ##### FUNCTION sbuild_config_new_from_file ##### --> -<para> - -</para> - -@file: -@Returns: - - -<!-- ##### FUNCTION sbuild_config_new_from_directory ##### --> -<para> - -</para> - -@dir: -@Returns: - - -<!-- ##### FUNCTION sbuild_config_add_config_file ##### --> -<para> - -</para> - -@config: -@file: - - -<!-- ##### FUNCTION sbuild_config_add_config_directory ##### --> -<para> - -</para> - -@config: -@dir: - - -<!-- ##### FUNCTION sbuild_config_get_chroots ##### --> -<para> - -</para> - -@config: -@Returns: - - -<!-- ##### FUNCTION sbuild_config_find_chroot ##### --> -<para> - -</para> - -@config: -@name: -@Returns: - - -<!-- ##### FUNCTION sbuild_config_find_alias ##### --> -<para> - -</para> - -@config: -@name: -@Returns: - - -<!-- ##### FUNCTION sbuild_config_get_chroot_list ##### --> -<para> - -</para> - -@config: -@Returns: - - -<!-- ##### FUNCTION sbuild_config_print_chroot_list ##### --> -<para> - -</para> - -@config: -@file: - - -<!-- ##### FUNCTION sbuild_config_print_chroot_info ##### --> -<para> - -</para> - -@config: -@chroots: -@file: - - -<!-- ##### FUNCTION sbuild_config_validate_chroots ##### --> -<para> - -</para> - -@config: -@chroots: -@Returns: - - diff --git a/doc/schroot/tmpl/sbuild-error.sgml b/doc/schroot/tmpl/sbuild-error.sgml deleted file mode 100644 index 15d9ff85..00000000 --- a/doc/schroot/tmpl/sbuild-error.sgml +++ /dev/null @@ -1,41 +0,0 @@ -<!-- ##### SECTION Title ##### --> - - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### TYPEDEF SbuildErrorPointer ##### --> -<para> -A typedef to represent a pointer to a GError. This should probably -not need to be used in user code; it is mainly useful for gtk-doc -signal documentation through type introspection. -</para> - - -<!-- ##### MACRO SBUILD_TYPE_ERROR ##### --> -<para> -Get the GType for a GError. -</para> - - - -<!-- ##### MACRO SBUILD_TYPE_ERROR_POINTER ##### --> -<para> -Get the GType for an SbuildErrorPointer (GError *). -</para> - - - diff --git a/doc/schroot/tmpl/sbuild-lock.sgml b/doc/schroot/tmpl/sbuild-lock.sgml deleted file mode 100644 index 8c506b5d..00000000 --- a/doc/schroot/tmpl/sbuild-lock.sgml +++ /dev/null @@ -1,93 +0,0 @@ -<!-- ##### SECTION Title ##### --> - - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### MACRO SBUILD_LOCK_ERROR ##### --> -<para> -The error domain for sbuild lock errors. -</para> - - - -<!-- ##### ENUM SbuildLockError ##### --> -<para> -The errors which can occur while acquiring a lock. -</para> - -@SBUILD_LOCK_ERROR_SETUP: An error occured while setting up timeout handling. -@SBUILD_LOCK_ERROR_TIMEOUT: A timeout occured while waiting on the lock. -@SBUILD_LOCK_ERROR_FAIL: Lock acquisition failed. - -<!-- ##### ENUM SbuildLockType ##### --> -<para> -The type of lock. A shared lock may be held simultaneously by many -processes, whereas an exclusive lock may only be held by only one -process. If a shared lock is already held by another process, a -shared lock may be acquired, but not an exclusive lock. If an -exclusive lock is held by another process, both shared and exclusive -lock acquisition will fail. -</para> - -@SBUILD_LOCK_SHARED: A shared (read) lock. -@SBUILD_LOCK_EXCLUSIVE: An exclusive (write) lock. -@SBUILD_LOCK_NONE: No lock. - -<!-- ##### FUNCTION sbuild_lock_set_lock ##### --> -<para> - -</para> - -@fd: -@lock_type: -@timeout: -@error: -@Returns: - - -<!-- ##### FUNCTION sbuild_lock_unset_lock ##### --> -<para> - -</para> - -@fd: -@error: -@Returns: - - -<!-- ##### FUNCTION sbuild_lock_set_device_lock ##### --> -<para> - -</para> - -@device: -@lock_type: -@timeout: -@error: -@Returns: - - -<!-- ##### FUNCTION sbuild_lock_unset_device_lock ##### --> -<para> - -</para> - -@device: -@error: -@Returns: - - diff --git a/doc/schroot/tmpl/sbuild-marshallers.sgml b/doc/schroot/tmpl/sbuild-marshallers.sgml deleted file mode 100644 index ab4b18c8..00000000 --- a/doc/schroot/tmpl/sbuild-marshallers.sgml +++ /dev/null @@ -1,63 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Closure Marshallers - -<!-- ##### SECTION Short_Description ##### --> -Closure Marshallers - -<!-- ##### SECTION Long_Description ##### --> -<para> -These closure marshaller (GClosureMarshal) functions are used during -GObject signal emission to marshal arguments for invoking signal -handlers (closures). Please see the GObject documentation for further -details. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### FUNCTION sbuild_cclosure_marshal_ENUM__VOID ##### --> -<para> -A marshaller for a GCClosure with a callback of type enum (*callback) (gpointer instance, gpointer user_data). -</para> - -@closure: the GClosure to which the marshaller belongs -@return_value: a GValue which can store the returned enum -@n_param_values: 1 -@param_values: a GValue array holding only the instance -@invocation_hint: the invocation hint given as the the last argument to g_closure_invoke() -@marshal_data: additional data specified when registering the marshaller - - -<!-- ##### FUNCTION sbuild_cclosure_marshal_BOOLEAN__BOXED ##### --> -<para> -A marshaller for a GCClosure with a callback of type boolean -(*callback) (gpointer instance, GBoxed *arg1, gpointer user_data). -</para> - -@closure: the GClosure to which the marshaller belongs -@return_value: a GValue which can store the returned gboolean -@n_param_values: 2 -@param_values: a GValue array holding instance and arg1 -@invocation_hint: the invocation hint given as the the last argument to g_closure_invoke() -@marshal_data: additional data specified when registering the marshaller - - -<!-- ##### FUNCTION sbuild_cclosure_marshal_BOOLEAN__UINT_BOXED ##### --> -<para> -A marshaller for a GCClosure with a callback of type boolean -(*callback) (gpointer instance, guint arg1, GBoxed *arg2, gpointer user_data). -</para> - -@closure: the GClosure to which the marshaller belongs -@return_value: a GValue which can store the returned gboolean -@n_param_values: 3 -@param_values: a GValue array holding instance, arg1 and arg2. -@invocation_hint: the invocation hint given as the the last argument to g_closure_invoke() -@marshal_data: additional data specified when registering the marshaller - - diff --git a/doc/schroot/tmpl/sbuild-session.sgml b/doc/schroot/tmpl/sbuild-session.sgml deleted file mode 100644 index 61956ed5..00000000 --- a/doc/schroot/tmpl/sbuild-session.sgml +++ /dev/null @@ -1,201 +0,0 @@ -<!-- ##### SECTION Title ##### --> - - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT SbuildSession ##### --> -<para> -SbuildSession object. -</para> - - -<!-- ##### ARG SbuildSession:child-status ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildSession:chroots ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildSession:config ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildSession:force ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildSession:operation ##### --> -<para> - -</para> - -<!-- ##### ARG SbuildSession:session-id ##### --> -<para> - -</para> - -<!-- ##### STRUCT SbuildSessionClass ##### --> -<para> -SbuildSession class. -</para> - -@parent: the parent class - -<!-- ##### ENUM SbuildSessionError ##### --> -<para> -The errors which can occur while running a session. -</para> - -@SBUILD_SESSION_ERROR_FORK: A child process could not be created -@SBUILD_SESSION_ERROR_CHILD: An error occured during execution of the child process -@SBUILD_SESSION_ERROR_CHROOT: An error occured finding the chroot -@SBUILD_SESSION_ERROR_CHROOT_SETUP: An error occured while running the setup scripts - -<!-- ##### ENUM SbuildSessionOperation ##### --> -<para> -The operation to perform when the session is run. -</para> - -@SBUILD_SESSION_OPERATION_AUTOMATIC: Create, run and end the session automatically -@SBUILD_SESSION_OPERATION_BEGIN: Create a session and return the session id -@SBUILD_SESSION_OPERATION_RECOVER: Recover a session -@SBUILD_SESSION_OPERATION_END: End a session -@SBUILD_SESSION_OPERATION_RUN: Run a session - -<!-- ##### MACRO SBUILD_SESSION_ERROR ##### --> -<para> -The error domain for sbuild session errors. -</para> - - - -<!-- ##### FUNCTION sbuild_session_new ##### --> -<para> - -</para> - -@service: -@config: -@operation: -@chroots: -@Returns: - - -<!-- ##### FUNCTION sbuild_session_get_config ##### --> -<para> - -</para> - -@session: -@Returns: - - -<!-- ##### FUNCTION sbuild_session_set_config ##### --> -<para> - -</para> - -@session: -@config: - - -<!-- ##### FUNCTION sbuild_session_get_operation ##### --> -<para> - -</para> - -@session: -@Returns: - - -<!-- ##### FUNCTION sbuild_session_set_operation ##### --> -<para> - -</para> - -@session: -@operation: - - -<!-- ##### FUNCTION sbuild_session_get_session_id ##### --> -<para> - -</para> - -@session: -@Returns: - - -<!-- ##### FUNCTION sbuild_session_set_session_id ##### --> -<para> - -</para> - -@session: -@session_id: - - -<!-- ##### FUNCTION sbuild_session_get_force ##### --> -<para> - -</para> - -@session: -@Returns: - - -<!-- ##### FUNCTION sbuild_session_set_force ##### --> -<para> - -</para> - -@session: -@force: - - -<!-- ##### FUNCTION sbuild_session_get_chroots ##### --> -<para> - -</para> - -@session: -@Returns: - - -<!-- ##### FUNCTION sbuild_session_set_chroots ##### --> -<para> - -</para> - -@session: -@chroots: - - -<!-- ##### FUNCTION sbuild_session_get_child_status ##### --> -<para> - -</para> - -@session: -@Returns: - - diff --git a/doc/schroot/tmpl/schroot-options.sgml b/doc/schroot/tmpl/schroot-options.sgml deleted file mode 100644 index 8a73c7c7..00000000 --- a/doc/schroot/tmpl/schroot-options.sgml +++ /dev/null @@ -1,68 +0,0 @@ -<!-- ##### SECTION Title ##### --> -SchrootOptions - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT SchrootOptions ##### --> -<para> -This structure contains the options obtained from the command-line -options. -</para> - -@chroots: The chroots to use. -@command: The command to run. -@user: The user to run as. -@preserve: Preserve the user's environment? -@quiet: Quiet messages? -@verbose: Verbose messages? -@list: List chroots? -@info: Print chroot information? -@all: Use all chroots and sessions? -@all_chroots: Use all chroots? -@all_sessions: Use all sessions? -@load_chroots: Load chroots? -@load_sessions: Load sessions? -@version: Print version? -@session_operation: Session operation to perform. -@session_force: Force session operation? - -<!-- ##### FUNCTION schroot_options_new ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION schroot_options_parse ##### --> -<para> - -</para> - -@argc: -@argv: -@Returns: - - -<!-- ##### FUNCTION schroot_options_free ##### --> -<para> - -</para> - -@options: - - |