summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRoger Leigh <rleigh@debian.org>2005-09-11 18:59:17 +0000
committerRoger Leigh <rleigh@debian.org>2005-09-11 18:59:17 +0000
commit1105038f9ee7f14ff85cf25f9b3c11a90b996d54 (patch)
treeb3d9ef6c12d603af38fbc2df35400ab3e43fd56b /doc
parent328d3d571b83f33dc15bd7117b5664a85dac9244 (diff)
downloadschroot-1105038f9ee7f14ff85cf25f9b3c11a90b996d54.tar.gz
* Update API reference.
* schroot/schroot.1.in: Document new option, and the AUTH_VERBOSITY environment variable used in setup scripts. * schroot/schroot.c (parse_options): Add a new --verbose option. (main): Set requested verbosity level. * schroot/sbuild-session.c (sbuild_session_setup_chroot): Check verbosity level to set in the environment, and to pass to run-parts. (sbuild_session_run_child): Check verbosity level when printing information about the command being run. * schroot/sbuild-auth.c (sbuild_auth_get_verbosity): Replacement for sbuild_auth_get_quiet. (sbuild_auth_set_verbosity): Replacement for sbuild_auth_set_quiet. (sbuild_auth_class_init): Replace "quiet" property with "verbosity" property. * schroot/sbuild-auth.h: Add SbuildAuthVerbosity enum to specify message verbosity. (struct _SbuildAuth): Replace quiet member with verbosity member.
Diffstat (limited to 'doc')
-rw-r--r--doc/schroot/schroot-sections.txt7
-rw-r--r--doc/schroot/tmpl/sbuild-auth.sgml25
-rw-r--r--doc/schroot/tmpl/sbuild-session.sgml2
3 files changed, 23 insertions, 11 deletions
diff --git a/doc/schroot/schroot-sections.txt b/doc/schroot/schroot-sections.txt
index ddd7058d..9bccd939 100644
--- a/doc/schroot/schroot-sections.txt
+++ b/doc/schroot/schroot-sections.txt
@@ -67,6 +67,7 @@ SbuildAuthRequireAuthFunc
SbuildAuthSessionRunFunc
SbuildAuthClass
SbuildAuthStatus
+SbuildAuthVerbosity
sbuild_auth_new
sbuild_auth_get_service
sbuild_auth_get_uid
@@ -82,8 +83,8 @@ sbuild_auth_set_environment
sbuild_auth_get_pam_environment
sbuild_auth_get_ruid
sbuild_auth_get_ruser
-sbuild_auth_get_quiet
-sbuild_auth_set_quiet
+sbuild_auth_get_verbosity
+sbuild_auth_set_verbosity
sbuild_auth_get_conv
sbuild_auth_set_conv
sbuild_auth_start
@@ -102,6 +103,8 @@ 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
diff --git a/doc/schroot/tmpl/sbuild-auth.sgml b/doc/schroot/tmpl/sbuild-auth.sgml
index 7609e8f4..b2f90ab4 100644
--- a/doc/schroot/tmpl/sbuild-auth.sgml
+++ b/doc/schroot/tmpl/sbuild-auth.sgml
@@ -92,11 +92,6 @@ error (@error must be set appropriately).
</para>
-<!-- ##### ARG SbuildAuth:quiet ##### -->
-<para>
-
-</para>
-
<!-- ##### ARG SbuildAuth:ruid ##### -->
<para>
@@ -127,6 +122,11 @@ error (@error must be set appropriately).
</para>
+<!-- ##### ARG SbuildAuth:verbosity ##### -->
+<para>
+
+</para>
+
<!-- ##### USER_FUNCTION SbuildAuthRequireAuthFunc ##### -->
<para>
The function prototype required for use with the require_auth virtual
@@ -168,6 +168,15 @@ The status of the authentication process.
@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.
+
<!-- ##### FUNCTION sbuild_auth_new ##### -->
<para>
@@ -305,7 +314,7 @@ The status of the authentication process.
@Returns:
-<!-- ##### FUNCTION sbuild_auth_get_quiet ##### -->
+<!-- ##### FUNCTION sbuild_auth_get_verbosity ##### -->
<para>
</para>
@@ -314,13 +323,13 @@ The status of the authentication process.
@Returns:
-<!-- ##### FUNCTION sbuild_auth_set_quiet ##### -->
+<!-- ##### FUNCTION sbuild_auth_set_verbosity ##### -->
<para>
</para>
@auth:
-@quiet:
+@verbosity:
<!-- ##### FUNCTION sbuild_auth_get_conv ##### -->
diff --git a/doc/schroot/tmpl/sbuild-session.sgml b/doc/schroot/tmpl/sbuild-session.sgml
index 5c239130..c10ed158 100644
--- a/doc/schroot/tmpl/sbuild-session.sgml
+++ b/doc/schroot/tmpl/sbuild-session.sgml
@@ -25,7 +25,7 @@ The errors which can occur while running a session.
@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:
+@SBUILD_SESSION_ERROR_CHROOT_SETUP: An error occured while running the setup scripts
<!-- ##### MACRO SBUILD_SESSION_ERROR ##### -->
<para>