[virt-tools-list] [libosinfo 1/2] install-config: Document expected kbd layout format

[Zeeshan Ali (Khattak)]

From: "Zeeshan Ali (Khattak)" <zeeshanak at gnome.org>

---
 osinfo/osinfo_install_config.c | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/osinfo/osinfo_install_config.c b/osinfo/osinfo_install_config.c
index adbf9df..e7a8946 100644
--- a/osinfo/osinfo_install_config.c
+++ b/osinfo/osinfo_install_config.c
@@ -124,7 +124,19 @@ const gchar *osinfo_install_config_get_hardware_arch(OsinfoInstallConfig *config
                                          OSINFO_INSTALL_CONFIG_PROP_HARDWARE_ARCH);
 }
 
-
+/**
+ * osinfo_install_config_set_l10n_keyboard:
+ *
+ * Sets the #OSINFO_INSTALL_CONFIG_PROP_L10N_KEYBOARD parameter.
+ *
+ * The expected format of this string is an X Window System keyboard layout
+ * specifier:
+ *
+ * http://www.freedesktop.org/wiki/Software/XKeyboardConfig
+ * http://fedoraproject.org/wiki/Anaconda/Kickstart#keyboard
+ *
+ * Examples: 'am (eastern-alt)', 'am', 'us', 'fi (classic)' etc.
+ */
 void osinfo_install_config_set_l10n_keyboard(OsinfoInstallConfig *config,
                                              const gchar *keyboard)
 {
-- 
1.8.0