[Libosinfo] [libosinfo 1/2] Improve osinfo_install_config_new API doc

Christophe Fergeau cfergeau at redhat.com
Wed Dec 19 10:14:28 UTC 2012


It was inaccurately saying that the newly created OsinfoInstallConfig
is empty while it has some default values set.
---
 osinfo/osinfo_install_config.c | 10 ++++++++--
 1 file 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)
 {
-- 
1.8.0.2




More information about the Libosinfo mailing list