diff options
| author | Christophe Fergeau <cfergeau@redhat.com> | 2012-12-19 10:55:44 +0100 |
|---|---|---|
| committer | Christophe Fergeau <cfergeau@redhat.com> | 2012-12-20 17:42:02 +0100 |
| commit | 8aab9902e848af07cba21d03ab4b9dda93945a2f (patch) | |
| tree | 0c4342998d159aaec0cfae64ca87c6abc03cc641 /osinfo | |
| parent | 9052d95a3140db536fa9416e83694d4c9ea35cd6 (diff) | |
docs: Improve osinfo_install_config_new API doc
It was inaccurately saying that the newly created OsinfoInstallConfig
is empty while it has some default values set.
Diffstat (limited to 'osinfo')
| -rw-r--r-- | osinfo/osinfo_install_config.c | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/osinfo/osinfo_install_config.c b/osinfo/osinfo_install_config.c index 64e7ed5..219a8e2 100644 --- a/osinfo/osinfo_install_config.c +++ b/osinfo/osinfo_install_config.c @@ -99,9 +99,15 @@ osinfo_install_config_init (OsinfoInstallConfig *config) * osinfo_install_config_new: * @id: the unique identifier * - * Construct a new install configuration that is initially empty. + * Construct a new install configuration with default values for + * language, keyboard, timezone and admin password. The default values + * are to use an 'us' keyboard, an 'en_US.UTF-8' language and an + * 'America/New_York' timezone. The admin password is set to a random + * 8 character password. + * + * Returns: (transfer full): an install configuration with default + * values * - * Returns: (transfer full): an empty install configuration */ OsinfoInstallConfig *osinfo_install_config_new(const gchar *id) { |