Re: [Libosinfo] [osinfo-db-tools PATCH v3 0/9] Drop GVFS dependency in favour of libsoup (+ some cleanups)
On 7/11/19 3:34 PM, Fabiano Fidêncio wrote: > Let's rely on libsoup in order to to http://, https://, and ftp:// > requests. > > By doing this, GVFS (more specifically, gvfs-http) won't be dragged as > a dependency, which caused errors for running osinfo-db-import as root > (as GVFS relies on being run in the user's session). > > https://gitlab.com/libosinfo/libosinfo/issues/30 > > The cleanups are basically in order to use g_clear_*() functions. > With the caveats that my glib is weak, I've never coded against libsoup, and I don't have any real work flow around osinfo-db-tools usage, I didn't notice anything wrong with this series, so: Reviewed-by: Cole Robinson - Cole ___ Libosinfo mailing list Libosinfo@redhat.com https://www.redhat.com/mailman/listinfo/libosinfo
Re: [Libosinfo] [osinfo-db PATCH 0/2] A few fixes for CentOS 7
On 7/12/19 8:53 AM, Fabiano Fidêncio wrote: > The first patch fixes the os/distro comparison, which requires the string > to be single-quoted; > > The second patch adjusts CentOS 7 name for its variants; > > Fabiano Fidêncio (2): > install-script,centos: Fix distro comparision > centos: Adjust the variant names to CentOS 7 > > data/install-script/redhat.com/rhel-kickstart-desktop.xml.in | 2 +- > data/os/centos.org/centos-7.0.xml.in | 4 ++-- > 2 files changed, 3 insertions(+), 3 deletions(-) > Reviewed-by: Cole Robinson - Cole ___ Libosinfo mailing list Libosinfo@redhat.com https://www.redhat.com/mailman/listinfo/libosinfo
Re: [Libosinfo] [libosinfo PATCH 00/20] Add "Since: ..." to the function's documentation
On 7/15/19 9:01 AM, Fabiano Fidêncio wrote: > This series adds "Since: ..." information as part of the function's > documentation. It helps developers reading our docs to easily figure out > when a function has been introduced. > > For functions missing documentation, it has been added as part of this > series as well. > > And, last but not least, this series addresses everything released since > the first release. For the first release, it doesn't actually make sense > to add "Since: ...", although it would be good to have those functions > documented at some point (but not as part of this series). > > Fabiano Fidêncio (20): > Add "Since: 0.0.3" to the documentation > Add "Since: 0.0.5" to the documentation > Add "Since: 0.0.6" to the documentation > Add "Since: 0.1.0" to the documentation > Add "Since: 0.2.0" to the documentation > Add "Since: 0.2.1" to the documentation > Add "Since: 0.2.2" to the documentation > Add "Since: 0.2.3" to the documentation > Add "Since: 0.2.6" to the documentation > Add "Since: 0.2.7" to the documentation > Add "Since: 0.2.8" to the documentation > Add "Since: 0.2.9" to the documentation > Add "Since: 0.2.10" to the documentation > Add "Since: 0.2.11" to the documentation > Add "Since: 0.2.12" to the documentation > Add "Since: 0.2.13" to the documentation > Add "Since: 1.3.0" to the documentation > Add "Since: 1.4.0" to the documentation > Add "Since: 1.5.0" to the documentation > Add "Since: 1.6.0" to the documentation Reviewed-by: Cole Robinson I checked the formatting and reviewed the doc strings, and verified that virt-manager test suite doesn't complain so presumably gobject introspection bits are still working for the APIs we use. - Cole ___ Libosinfo mailing list Libosinfo@redhat.com https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 10/20] Add "Since: 0.2.7" to the documentation
Let's add the "Since: ..." information as part of the function's documentation. It helps developers reading our docs to easily figure out when a function has been introduced. Signed-off-by: Fabiano Fidêncio --- osinfo/osinfo_install_script.c | 2 ++ osinfo/osinfo_platform.c | 2 ++ 2 files changed, 4 insertions(+) diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c index 826b9e2..d9a0ee7 100644 --- a/osinfo/osinfo_install_script.c +++ b/osinfo/osinfo_install_script.c @@ -1725,6 +1725,8 @@ GFile *osinfo_install_script_generate_output_for_media(OsinfoInstallScript *scri * #osinfo_install_script_generate_command_line_for_media() instead. * * Returns: (transfer full): The generated command line string, NULL otherwise. + * + * Since: 0.2.7 */ gchar *osinfo_install_script_generate_command_line(OsinfoInstallScript *script, OsinfoOs *os, diff --git a/osinfo/osinfo_platform.c b/osinfo/osinfo_platform.c index 3864866..afc4957 100644 --- a/osinfo/osinfo_platform.c +++ b/osinfo/osinfo_platform.c @@ -129,6 +129,8 @@ static void get_all_devices_cb(OsinfoProduct *product, gpointer user_data) * all derived and upgraded platforms. * * Returns: (transfer full): A list of devices + * + * Since: 0.2.7 */ OsinfoDeviceList *osinfo_platform_get_all_devices(OsinfoPlatform *platform, OsinfoFilter *filter) -- 2.21.0 ___ Libosinfo mailing list Libosinfo@redhat.com https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 11/20] Add "Since: 0.2.8" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Together with this change, documentation has been added to the functions
missing them.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_avatar_format.c| 2 ++
osinfo/osinfo_install_config.c | 45
osinfo/osinfo_install_config_param.c | 11 +++
osinfo/osinfo_install_script.c | 8 +
osinfo/osinfo_loader.c | 22 +-
osinfo/osinfo_product.c | 40 +
6 files changed, 127 insertions(+), 1 deletion(-)
diff --git a/osinfo/osinfo_avatar_format.c b/osinfo/osinfo_avatar_format.c
index ade4d09..3580e81 100644
--- a/osinfo/osinfo_avatar_format.c
+++ b/osinfo/osinfo_avatar_format.c
@@ -175,6 +175,8 @@ osinfo_avatar_format_init(OsinfoAvatarFormat *avatar)
*
* Returns: (transfer full): the necessary information to create an avatar for
* an user
+ *
+ * Since: 0.2.8
*/
OsinfoAvatarFormat *
osinfo_avatar_format_new(void)
diff --git a/osinfo/osinfo_install_config.c b/osinfo/osinfo_install_config.c
index 2bd5e4b..3d072d9 100644
--- a/osinfo/osinfo_install_config.c
+++ b/osinfo/osinfo_install_config.c
@@ -135,6 +135,15 @@ void
osinfo_install_config_set_hardware_arch(OsinfoInstallConfig *config,
}
+/**
+ * osinfo_install_config_get_hardware_arch:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_HARDWARE_ARCH parameter,
+ * or NULL.
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_install_config_get_hardware_arch(OsinfoInstallConfig
*config)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -476,6 +485,15 @@ void
osinfo_install_config_set_reg_login(OsinfoInstallConfig *config,
name);
}
+/**
+ * osinfo_install_config_get_reg_login:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_REG_LOGIN paramater,
+ * or NULL.
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_install_config_get_reg_login(OsinfoInstallConfig *config)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -500,6 +518,15 @@ void
osinfo_install_config_set_reg_password(OsinfoInstallConfig *config,
password);
}
+/**
+ * osinfo_install_config_get_reg_password:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_REG_PASSWORD paramater,
+ * or NULL.
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_install_config_get_reg_password(OsinfoInstallConfig
*config)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -524,6 +551,15 @@ void
osinfo_install_config_set_reg_product_key(OsinfoInstallConfig *config,
key);
}
+/**
+ * osinfo_install_config_get_reg_product_key:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_REG_PRODUCTKEY paramater,
+ * or NULL.
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_install_config_get_reg_product_key(OsinfoInstallConfig
*config)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
@@ -554,6 +590,15 @@ void
osinfo_install_config_set_hostname(OsinfoInstallConfig *config,
hostname);
}
+/**
+ * osinfo_install_config_get_hostname:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_HOSTNAME parameter,
+ * or NULL.
+ *
+ * Since: 0.2.8
+ */
const gchar *osinfo_install_config_get_hostname(OsinfoInstallConfig *config)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(config),
diff --git a/osinfo/osinfo_install_config_param.c
b/osinfo/osinfo_install_config_param.c
index ab854b3..13fa088 100644
--- a/osinfo/osinfo_install_config_param.c
+++ b/osinfo/osinfo_install_config_param.c
@@ -277,6 +277,15 @@ gboolean
osinfo_install_config_param_is_optional(OsinfoInstallConfigParam *confi
OSINFO_INSTALL_CONFIG_PARAM_POLICY_OPTIONAL);
}
+/**
+ * osinfo_install_config_get_value_map:
+ * @config_param: the configuration parameter
+ *
+ * Returns: (transfer none): The data map used to transform values set for this
+ * parameter to OS-specific values, or NULL.
+ *
+ * Since: 0.2.8
+ */
OsinfoDatamap
*osinfo_install_config_param_get_value_map(OsinfoInstallConfigParam
*config_param)
{
return config_param->priv->value_map;
@@ -291,6 +300,8 @@ OsinfoDatamap
*osinfo_install_config_param_get_value_map(OsinfoInstallConfigPara
* After a call to osinfo_install_config_param_set_value_map(), @datamap will
* be used to transform values set for this parameter to OS-specific
* values. A NULL @datamap will disable transformations.
+ *
+ * Since: 0.2.8
*/
void osinfo_install_config_param_set_value_map(OsinfoInstallConfigParam
*config_param,
[Libosinfo] [libosinfo PATCH 20/20] Add "Since: 1.6.0" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Together with this change, documentation has been added to the functions
missing them.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_db.c| 2 ++
osinfo/osinfo_media.c | 10 +-
osinfo/osinfo_media.h | 1 +
3 files changed, 12 insertions(+), 1 deletion(-)
diff --git a/osinfo/osinfo_db.c b/osinfo/osinfo_db.c
index a2fc8bc..b5cdb71 100644
--- a/osinfo/osinfo_db.c
+++ b/osinfo/osinfo_db.c
@@ -980,6 +980,8 @@ static void fill_tree(OsinfoDb *db, OsinfoTree *tree,
* properties will be set.
*
* Returns: TRUE if @tree was found in @db, FALSE otherwise
+ *
+ * Since: 1.6.0
*/
gboolean osinfo_db_identify_tree(OsinfoDb *db,
OsinfoTree *tree)
diff --git a/osinfo/osinfo_media.c b/osinfo/osinfo_media.c
index ad21b78..cf624d2 100644
--- a/osinfo/osinfo_media.c
+++ b/osinfo/osinfo_media.c
@@ -777,6 +777,8 @@ OsinfoMedia *osinfo_media_create_from_location(const gchar
*location,
* NOTE: Currently this only works for ISO images/devices.
*
* Returns: (transfer full): a new #OsinfoMedia , or NULL on error
+ *
+ * Since: 1.6.0
*/
OsinfoMedia *osinfo_media_create_from_location_with_flags(const gchar
*location,
GCancellable
*cancellable,
@@ -1349,6 +1351,8 @@ void osinfo_media_create_from_location_async(const gchar
*location,
* #osinfo_media_create_from_location_async.
*
* Returns: (transfer full): a new #OsinfoMedia , or NULL on error
+ *
+ * Since: 1.6.0
*/
OsinfoMedia *osinfo_media_create_from_location_finish(GAsyncResult *res,
GError **error)
@@ -1365,7 +1369,9 @@ OsinfoMedia
*osinfo_media_create_from_location_finish(GAsyncResult *res,
* @flags: An #OsinfoMediaDetectFlag, or 0.
* @user_data: The user data to pass to @callback, or %NULL
*
- * Asynchronous variant of #osinfo_media_create_from_location.
+ * Asynchronous variant of #osinfo_media_create_from_location_with_flags.
+ *
+ * Since: 1.6.0
*/
void osinfo_media_create_from_location_with_flags_async(const gchar *location,
gint priority,
@@ -1833,6 +1839,8 @@ OsinfoInstallScriptList
*osinfo_media_get_install_script_list(OsinfoMedia *media
* @media: and #OsinfoMedia instance
*
* Returns: #TRUE if the @media is bootable. #FALSE otherwise.
+ *
+ * Since: 1.6.0
*/
gboolean osinfo_media_is_bootable(OsinfoMedia *media)
{
diff --git a/osinfo/osinfo_media.h b/osinfo/osinfo_media.h
index fda5243..8eeb0e2 100644
--- a/osinfo/osinfo_media.h
+++ b/osinfo/osinfo_media.h
@@ -60,6 +60,7 @@ typedef enum {
/**
* OsinfoMediaDetectFlags
+ * Since: 1.6.0
* OSINFO_MEDIA_DETECT_REQUIRE_BOOTABLE: Requires a media to be bootable.
*
* Flags used for detecting a media.
--
2.21.0
___
Libosinfo mailing list
Libosinfo@redhat.com
https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 14/20] Add "Since: 0.2.11" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_install_script.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index 9ae6712..8166a70 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -1937,6 +1937,8 @@ unsigned int
osinfo_install_script_get_injection_methods(OsinfoInstallScript *sc
*
* Returns: TRUE if script needs an internet connection, FALSE otherwise
* internet connection.
+ *
+ * Since: 0.2.11
*/
gboolean osinfo_install_script_get_needs_internet(OsinfoInstallScript *script)
{
--
2.21.0
___
Libosinfo mailing list
Libosinfo@redhat.com
https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 04/20] Add "Since: 0.1.0" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Together with this change, documentation has been added to the functions
missing them.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_tree.c | 43
osinfo/osinfo_treelist.c | 14 +
2 files changed, 57 insertions(+)
diff --git a/osinfo/osinfo_tree.c b/osinfo/osinfo_tree.c
index b797cb4..f804e46 100644
--- a/osinfo/osinfo_tree.c
+++ b/osinfo/osinfo_tree.c
@@ -67,6 +67,15 @@ static void
create_from_location_data_free(CreateFromLocationData *data)
g_slice_free(CreateFromLocationData, data);
}
+/**
+ * osinfo_tree_error_quark:
+ *
+ * Gets a #GQuark representing the string "osinfo-tree-error"
+ *
+ * Returns: the #GQuark representing the string.
+ *
+ * Since: 0.1.0
+ */
GQuark
osinfo_tree_error_quark(void)
{
@@ -425,6 +434,18 @@ osinfo_tree_init(OsinfoTree *tree)
g_weak_ref_init(>priv->os, NULL);
}
+/**
+ * osinfo_tree_new:
+ *
+ * @id: the id of the tree to be created
+ * @architecture: the architecture of the tree to be created
+ *
+ * Create a new tree entity
+ *
+ * Returns: (trasfer full): A tree entity
+ *
+ * Since: 0.1.0
+ */
OsinfoTree *osinfo_tree_new(const gchar *id,
const gchar *architecture)
{
@@ -464,6 +485,8 @@ static void on_tree_create_from_location_ready(GObject
*source_object,
* NOTE: Currently this only works for trees with a .treeinfo file
*
* Returns: (transfer full): a new #OsinfoTree , or NULL on error
+ *
+ * Since: 0.1.0
*/
OsinfoTree *osinfo_tree_create_from_location(const gchar *location,
GCancellable *cancellable,
@@ -713,6 +736,8 @@
osinfo_tree_create_from_location_async_helper(CreateFromLocationAsyncData *data,
* @user_data: The user data to pass to @callback, or %NULL
*
* Asynchronous variant of #osinfo_tree_create_from_location.
+ *
+ * Since: 0.1.0
*/
void osinfo_tree_create_from_location_async(const gchar *location,
gint priority,
@@ -744,6 +769,8 @@ void osinfo_tree_create_from_location_async(const gchar
*location,
* #osinfo_tree_create_from_location_async.
*
* Returns: (transfer full): a new #OsinfoTree , or NULL on error
+ *
+ * Since: 0.1.0
*/
OsinfoTree *osinfo_tree_create_from_location_finish(GAsyncResult *res,
GError **error)
@@ -762,6 +789,8 @@ OsinfoTree
*osinfo_tree_create_from_location_finish(GAsyncResult *res,
* Retrieves the target hardware architecture of the OS @tree provides.
*
* Returns: (transfer none): the hardware architecture, or NULL
+ *
+ * Since: 0.1.0
*/
const gchar *osinfo_tree_get_architecture(OsinfoTree *tree)
{
@@ -793,6 +822,8 @@ const gchar *osinfo_tree_get_url(OsinfoTree *tree)
* but rather a regular expression that matches it.
*
* Returns: (transfer none): the treeinfo family, or NULL
+ *
+ * Since: 0.1.0
*/
const gchar *osinfo_tree_get_treeinfo_family(OsinfoTree *tree)
{
@@ -810,6 +841,8 @@ const gchar *osinfo_tree_get_treeinfo_family(OsinfoTree
*tree)
* architecture but rather a regular expression that matches it.
*
* Returns: (transfer none): the treeinfo architecture, or NULL
+ *
+ * Since: 0.1.0
*/
const gchar *osinfo_tree_get_treeinfo_arch(OsinfoTree *tree)
{
@@ -827,6 +860,8 @@ const gchar *osinfo_tree_get_treeinfo_arch(OsinfoTree *tree)
* but rather a regular expression that matches it.
*
* Returns: (transfer none): the treeinfo variant, or NULL
+ *
+ * Since: 0.1.0
*/
const gchar *osinfo_tree_get_treeinfo_variant(OsinfoTree *tree)
{
@@ -844,6 +879,8 @@ const gchar *osinfo_tree_get_treeinfo_variant(OsinfoTree
*tree)
* rather a regular expression that matches it.
*
* Returns: (transfer none): the treeinfo version, or NULL
+ *
+ * Since: 0.1.0
*/
const gchar *osinfo_tree_get_treeinfo_version(OsinfoTree *tree)
{
@@ -858,6 +895,8 @@ const gchar *osinfo_tree_get_treeinfo_version(OsinfoTree
*tree)
* Retrieves the path to the boot_iso image in the install tree.
*
* Returns: (transfer none): the path to boot_iso image, or NULL
+ *
+ * Since: 0.1.0
*/
const gchar *osinfo_tree_get_boot_iso_path(OsinfoTree *tree)
{
@@ -874,6 +913,8 @@ const gchar *osinfo_tree_get_boot_iso_path(OsinfoTree *tree)
* Note: This only applies to installer trees of 'linux' OS family.
*
* Returns: (transfer none): the path to kernel image, or NULL
+ *
+ * Since: 0.1.0
*/
const gchar *osinfo_tree_get_kernel_path(OsinfoTree *tree)
{
@@ -890,6 +931,8 @@ const gchar *osinfo_tree_get_kernel_path(OsinfoTree *tree)
* Note: This only applies to installer trees of 'linux' OS family.
*
* Returns: (transfer none): the path to initrd image, or NULL
+ *
+ * Since: 0.1.0
*/
const gchar *osinfo_tree_get_initrd_path(OsinfoTree *tree)
{
diff --git
[Libosinfo] [libosinfo PATCH 18/20] Add "Since: 1.4.0" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_media.c | 4
osinfo/osinfo_os.h| 1 +
2 files changed, 5 insertions(+)
diff --git a/osinfo/osinfo_media.c b/osinfo/osinfo_media.c
index 9b693f6..ad21b78 100644
--- a/osinfo/osinfo_media.c
+++ b/osinfo/osinfo_media.c
@@ -1800,6 +1800,8 @@ gboolean
osinfo_media_supports_installer_script(OsinfoMedia *media)
* @script: an #OsinfoInstallScript instance
*
* Adds an @script to the specified @media
+ *
+ * Since: 1.4.0
*/
void osinfo_media_add_install_script(OsinfoMedia *media, OsinfoInstallScript
*script)
{
@@ -1813,6 +1815,8 @@ void osinfo_media_add_install_script(OsinfoMedia *media,
OsinfoInstallScript *sc
* @media: an #OsinfoMedia instance
*
* Returns: (transfer full): a list of the install scripts for the specified
media
+ *
+ * Since: 1.4.0
*/
OsinfoInstallScriptList *osinfo_media_get_install_script_list(OsinfoMedia
*media)
{
diff --git a/osinfo/osinfo_os.h b/osinfo/osinfo_os.h
index 2bec1c8..1521fbb 100644
--- a/osinfo/osinfo_os.h
+++ b/osinfo/osinfo_os.h
@@ -93,6 +93,7 @@ struct _OsinfoOsClass
* development snapshots of GNOME and nightly build ISOs of Fedora etc.
* @OSINFO_RELEASE_STATUS_PRERELEASE: A pre-release. For example, alpha and
* beta pre-releases of Fedora etc.
+ * Since: 1.4.0
* @OSINFO_RELEASE_STATUS_ROLLING: A rolling version of an OS and thus with no
* actual releases. For example, Gentoo, Arch Linux, etc.
*/
--
2.21.0
___
Libosinfo mailing list
Libosinfo@redhat.com
https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 02/20] Add "Since: 0.0.5" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_os.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/osinfo/osinfo_os.c b/osinfo/osinfo_os.c
index 08faf4f..afd84b0 100644
--- a/osinfo/osinfo_os.c
+++ b/osinfo/osinfo_os.c
@@ -338,6 +338,8 @@ osinfo_os_get_all_device_links_internal(OsinfoOs *os,
* systems.
*
* Returns: (transfer full): A list of devices
+ *
+ * Since: 0.0.5
*/
OsinfoDeviceList *osinfo_os_get_all_devices(OsinfoOs *os, OsinfoFilter *filter)
{
--
2.21.0
___
Libosinfo mailing list
Libosinfo@redhat.com
https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 00/20] Add "Since: ..." to the function's documentation
This series adds "Since: ..." information as part of the function's documentation. It helps developers reading our docs to easily figure out when a function has been introduced. For functions missing documentation, it has been added as part of this series as well. And, last but not least, this series addresses everything released since the first release. For the first release, it doesn't actually make sense to add "Since: ...", although it would be good to have those functions documented at some point (but not as part of this series). Fabiano Fidêncio (20): Add "Since: 0.0.3" to the documentation Add "Since: 0.0.5" to the documentation Add "Since: 0.0.6" to the documentation Add "Since: 0.1.0" to the documentation Add "Since: 0.2.0" to the documentation Add "Since: 0.2.1" to the documentation Add "Since: 0.2.2" to the documentation Add "Since: 0.2.3" to the documentation Add "Since: 0.2.6" to the documentation Add "Since: 0.2.7" to the documentation Add "Since: 0.2.8" to the documentation Add "Since: 0.2.9" to the documentation Add "Since: 0.2.10" to the documentation Add "Since: 0.2.11" to the documentation Add "Since: 0.2.12" to the documentation Add "Since: 0.2.13" to the documentation Add "Since: 1.3.0" to the documentation Add "Since: 1.4.0" to the documentation Add "Since: 1.5.0" to the documentation Add "Since: 1.6.0" to the documentation osinfo/osinfo_avatar_format.c| 10 + osinfo/osinfo_datamap.c | 39 osinfo/osinfo_datamaplist.c | 2 + osinfo/osinfo_db.c | 14 ++ osinfo/osinfo_device.c | 8 + osinfo/osinfo_device_driver.c| 12 + osinfo/osinfo_device_driverlist.c| 2 + osinfo/osinfo_entity.c | 114 ++ osinfo/osinfo_image.c| 14 ++ osinfo/osinfo_imagelist.c| 2 + osinfo/osinfo_install_config.c | 276 ++- osinfo/osinfo_install_config_param.c | 21 ++ osinfo/osinfo_install_config_param.h | 1 + osinfo/osinfo_install_config_paramlist.c | 2 + osinfo/osinfo_install_script.c | 160 - osinfo/osinfo_install_script.h | 3 + osinfo/osinfo_install_scriptlist.c | 10 + osinfo/osinfo_list.c | 8 + osinfo/osinfo_loader.c | 24 +- osinfo/osinfo_media.c| 30 ++- osinfo/osinfo_media.h| 1 + osinfo/osinfo_os.c | 48 osinfo/osinfo_os.h | 2 + osinfo/osinfo_os_variant.c | 13 ++ osinfo/osinfo_os_variantlist.c | 2 + osinfo/osinfo_platform.c | 2 + osinfo/osinfo_product.c | 42 osinfo/osinfo_tree.c | 51 + osinfo/osinfo_treelist.c | 14 ++ 29 files changed, 917 insertions(+), 10 deletions(-) -- 2.21.0 ___ Libosinfo mailing list Libosinfo@redhat.com https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 17/20] Add "Since: 1.3.0" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_image.c | 8
osinfo/osinfo_imagelist.c | 2 ++
osinfo/osinfo_install_script.c | 8
osinfo/osinfo_install_script.h | 1 +
osinfo/osinfo_loader.c | 2 ++
osinfo/osinfo_media.c | 2 ++
osinfo/osinfo_os.c | 14 ++
osinfo/osinfo_tree.c | 2 ++
8 files changed, 39 insertions(+)
diff --git a/osinfo/osinfo_image.c b/osinfo/osinfo_image.c
index 621ebf0..05115a7 100644
--- a/osinfo/osinfo_image.c
+++ b/osinfo/osinfo_image.c
@@ -230,6 +230,8 @@ OsinfoImage *osinfo_image_new(const gchar *id,
* Retrieves the target hardware architecture of the OS @image provides.
*
* Returns: (transfer none): the hardware architecture, or NULL
+ *
+ * Since: 1.3.0
*/
const gchar *osinfo_image_get_architecture(OsinfoImage *image)
{
@@ -244,6 +246,8 @@ const gchar *osinfo_image_get_architecture(OsinfoImage
*image)
* The format of the @image
*
* Returns: (transfer none): the format, or NULL
+ *
+ * Since: 1.3.0
*/
const gchar *osinfo_image_get_format(OsinfoImage *image)
{
@@ -258,6 +262,8 @@ const gchar *osinfo_image_get_format(OsinfoImage *image)
* The URL to the @image
*
* Returns: (transfer none): the URL, or NULL
+ *
+ * Since: 1.3.0
*/
const gchar *osinfo_image_get_url(OsinfoImage *image)
{
@@ -273,6 +279,8 @@ const gchar *osinfo_image_get_url(OsinfoImage *image)
*
* Returns: #TRUE if @image supports cloud init customizations, #FALSE
* otherwise.
+ *
+ * Since: 1.3.0
*/
gboolean osinfo_image_get_cloud_init(OsinfoImage *image)
{
diff --git a/osinfo/osinfo_imagelist.c b/osinfo/osinfo_imagelist.c
index 0187b89..0f822a8 100644
--- a/osinfo/osinfo_imagelist.c
+++ b/osinfo/osinfo_imagelist.c
@@ -73,6 +73,8 @@ osinfo_imagelist_init(OsinfoImageList *list)
* Construct a new image list that is initially empty.
*
* Returns: (transfer full): an empty image list
+ *
+ * Since: 1.3.0
*/
OsinfoImageList *osinfo_imagelist_new(void)
{
diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index 3d8c502..b96e134 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -1961,6 +1961,8 @@ gboolean
osinfo_install_script_get_needs_internet(OsinfoInstallScript *script)
* OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_WEB
*
* Set the preferred injection method to be used with the @script
+ *
+ * Since: 1.3.0
*/
void osinfo_install_script_set_preferred_injection_method(OsinfoInstallScript
*script,
OsinfoInstallScriptInjectionMethod method)
@@ -1988,6 +1990,8 @@ void
osinfo_install_script_set_preferred_injection_method(OsinfoInstallScript *s
* OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_DISK is supported,
* OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_DISK is returned, otherwise
* OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_INITRD is returned.
+ *
+ * Since: 1.3.0
*/
OsinfoInstallScriptInjectionMethod
osinfo_install_script_get_preferred_injection_method(OsinfoInstallScript
*script)
@@ -2025,6 +2029,8 @@
osinfo_install_script_get_preferred_injection_method(OsinfoInstallScript *script
* OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_NETWORK
*
* Set the installation source to be used with the @script.
+ *
+ * Since: 1.3.0
*/
void osinfo_install_script_set_installation_source(OsinfoInstallScript *script,
OsinfoInstallScriptInstallationSource source)
@@ -2041,6 +2047,8 @@ void
osinfo_install_script_set_installation_source(OsinfoInstallScript *script,
*
* Returns: the installation source to be used with the script. If none is
set, it defaults to
* OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_MEDIA.
+ *
+ * Since: 1.3.0
*/
OsinfoInstallScriptInstallationSource
osinfo_install_script_get_installation_source(OsinfoInstallScript *script)
diff --git a/osinfo/osinfo_install_script.h b/osinfo/osinfo_install_script.h
index ccd6cbc..626e66c 100644
--- a/osinfo/osinfo_install_script.h
+++ b/osinfo/osinfo_install_script.h
@@ -140,6 +140,7 @@ typedef enum {
/**
* OsinfoInstallScriptInstallationSource:
+ * Since: 1.3.0
* @OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_MEDIA: A media will be used as
* the installation source.
* @OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_NETWORK: A network method will
diff --git a/osinfo/osinfo_loader.c b/osinfo/osinfo_loader.c
index 6d1c801..51bd8ac 100644
--- a/osinfo/osinfo_loader.c
+++ b/osinfo/osinfo_loader.c
@@ -151,6 +151,8 @@ OsinfoLoader *osinfo_loader_new(void)
* Gets a #GQuark representing the string "libosinfo"
*
* Returns: the #GQuark representing the string.
+ *
+ * Since: 1.3.0
**/
GQuark
osinfo_error_quark(void)
diff --git a/osinfo/osinfo_media.c b/osinfo/osinfo_media.c
index
[Libosinfo] [libosinfo PATCH 19/20] Add "Since: 1.5.0" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_image.c | 6 ++
osinfo/osinfo_install_config.c | 4
osinfo/osinfo_product.c| 2 ++
osinfo/osinfo_tree.c | 6 ++
4 files changed, 18 insertions(+)
diff --git a/osinfo/osinfo_image.c b/osinfo/osinfo_image.c
index 05115a7..33fa58d 100644
--- a/osinfo/osinfo_image.c
+++ b/osinfo/osinfo_image.c
@@ -293,6 +293,8 @@ gboolean osinfo_image_get_cloud_init(OsinfoImage *image)
* @image: an #OsinfoImage instance
*
* Returns: (transfer full): the operating system, or NULL
+ *
+ * Since: 1.5.0
*/
OsinfoOs *osinfo_image_get_os(OsinfoImage *image)
{
@@ -307,6 +309,8 @@ OsinfoOs *osinfo_image_get_os(OsinfoImage *image)
* @os: an #OsinfoOs instance
*
* Sets the #OsinfoOs associated to the #OsinfoImage instance.
+ *
+ * Since: 1.5.0
*/
void osinfo_image_set_os(OsinfoImage *image, OsinfoOs *os)
{
@@ -324,6 +328,8 @@ void osinfo_image_set_os(OsinfoImage *image, OsinfoOs *os)
* Gets the varriants of the associated operating system
*
* Returns: (transfer full): the operating system variants, or NULL
+ *
+ * Since: 1.5.0
*/
OsinfoOsVariantList *osinfo_image_get_os_variants(OsinfoImage *image)
{
diff --git a/osinfo/osinfo_install_config.c b/osinfo/osinfo_install_config.c
index 3d072d9..caec643 100644
--- a/osinfo/osinfo_install_config.c
+++ b/osinfo/osinfo_install_config.c
@@ -963,6 +963,8 @@ gboolean
osinfo_install_config_get_driver_signing(OsinfoInstallConfig *config)
*
* When performing a tree based installation the script will need the
installation
* URL to be set, whenever the installation is performed from a non canonical
place.
+ *
+ * Since: 1.5.0
*/
void osinfo_install_config_set_installation_url(OsinfoInstallConfig *config,
const gchar *url)
@@ -977,6 +979,8 @@ void
osinfo_install_config_set_installation_url(OsinfoInstallConfig *config,
* @config: the install config
*
* Returns the URL the script will use to perform the installation.
+ *
+ * Since: 1.5.0
*/
const gchar *osinfo_install_config_get_installation_url(OsinfoInstallConfig
*config)
{
diff --git a/osinfo/osinfo_product.c b/osinfo/osinfo_product.c
index dbb7402..a767585 100644
--- a/osinfo/osinfo_product.c
+++ b/osinfo/osinfo_product.c
@@ -485,6 +485,8 @@ void osinfo_product_foreach_related(OsinfoProduct *product,
* Retrieve all the short-ids associated with the product.
*
* Returns: (transfer container) (element-type utf8): the list of short-ids.
+ *
+ * Since: 1.5.0
*/
GList *osinfo_product_get_short_id_list(OsinfoProduct *prod)
{
diff --git a/osinfo/osinfo_tree.c b/osinfo/osinfo_tree.c
index 98f2334..8a58dd9 100644
--- a/osinfo/osinfo_tree.c
+++ b/osinfo/osinfo_tree.c
@@ -961,6 +961,8 @@ gboolean osinfo_tree_has_treeinfo(OsinfoTree *tree)
* @tree: an #OsinfoTree instance
*
* Returns: (transfer full): the operating system, or NULL
+ *
+ * Since: 1.5.0
*/
OsinfoOs *osinfo_tree_get_os(OsinfoTree *tree)
{
@@ -976,6 +978,8 @@ OsinfoOs *osinfo_tree_get_os(OsinfoTree *tree)
* @os: an #OsinfoOs instance
*
* Sets the #OsinfoOs associated to the #OsinfoTree instance.
+ *
+ * Since: 1.5.0
*/
void osinfo_tree_set_os(OsinfoTree *tree, OsinfoOs *os)
{
@@ -993,6 +997,8 @@ void osinfo_tree_set_os(OsinfoTree *tree, OsinfoOs *os)
* Gets the variants of the associated operating system.
*
* Returns: (transfer full): the operating system variant, or NULL
+ *
+ * Since: 1.5.0
*/
OsinfoOsVariantList *osinfo_tree_get_os_variants(OsinfoTree *tree)
{
--
2.21.0
___
Libosinfo mailing list
Libosinfo@redhat.com
https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 06/20] Add "Since: 0.2.1" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Together with this change, documentation has been added to the functions
missing them.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_device.c | 8
osinfo/osinfo_entity.c | 59
osinfo/osinfo_install_config_param.c | 4 ++
osinfo/osinfo_install_script.c | 10 +++--
osinfo/osinfo_media.c| 2 +
5 files changed, 80 insertions(+), 3 deletions(-)
diff --git a/osinfo/osinfo_device.c b/osinfo/osinfo_device.c
index 6de3d2c..529a600 100644
--- a/osinfo/osinfo_device.c
+++ b/osinfo/osinfo_device.c
@@ -116,6 +116,14 @@ const gchar *osinfo_device_get_name(OsinfoDevice *dev)
return osinfo_entity_get_param_value(OSINFO_ENTITY(dev),
OSINFO_DEVICE_PROP_NAME);
}
+/**
+ * osinfo_device_get_subsystem:
+ * @dev: the device
+ *
+ * Returns: the value of the device's subsystem.
+ *
+ * Since: 0.2.1
+ */
const gchar *osinfo_device_get_subsystem(OsinfoDevice *dev)
{
return osinfo_entity_get_param_value(OSINFO_ENTITY(dev),
OSINFO_DEVICE_PROP_SUBSYSTEM);
diff --git a/osinfo/osinfo_entity.c b/osinfo/osinfo_entity.c
index f634d78..86d1c4a 100644
--- a/osinfo/osinfo_entity.c
+++ b/osinfo/osinfo_entity.c
@@ -204,6 +204,18 @@ void osinfo_entity_set_param_boolean(OsinfoEntity *entity,
const gchar *key, gbo
osinfo_entity_set_param(entity, key, value ? "true" : "false");
}
+/**
+ * osinfo_entity_set_param_int64:
+ * @entity: an #OsinfoEntity containing the parameters
+ * @key: the name of the key
+ * @value: the int64 value to be associated with that key
+ *
+ * Sets a new parameter against the entity. If the key already
+ * has a value associated with it, the existing value will be
+ * cleared.
+ *
+ * Since: 0.2.1
+ */
void osinfo_entity_set_param_int64(OsinfoEntity *entity, const gchar *key,
gint64 value)
{
gchar *str;
@@ -363,6 +375,23 @@ gboolean
osinfo_entity_get_param_value_boolean(OsinfoEntity *entity, const gchar
return value && str_to_bool(value);
}
+/**
+ * osinfo_entity_get_param_value_boolean_with_default:
+ * @entity: an #OsinfoEntity containing the parameters
+ * @key: the name of the key
+ * @default_value: the value to be returned in case there's no value
+ * associated with the @key
+ *
+ * Retrieve the parameter value associated with a named key as a
+ * boolean. If multiple values are stored against the key, only the
+ * first value is returned. If no value is associated, @default_value
+ * is returned.
+ *
+ * Returns: the value associated with the key as a boolean, or
+ * @default_value
+ *
+ * Since: 0.2.1
+ */
gboolean osinfo_entity_get_param_value_boolean_with_default(OsinfoEntity
*entity,
const char *key,
gboolean
default_value)
@@ -376,12 +405,42 @@ gboolean
osinfo_entity_get_param_value_boolean_with_default(OsinfoEntity *entity
return str_to_bool(value);
}
+/**
+ * osinfo_entity_get_param_value_int64:
+ * @entity: an #OsinfoEntity containing the parameters
+ * @key: the name of the key
+ *
+ * Retrieve the parameter value associated with a named key as an
+ * int64. If multiple values are stored against the key, only the
+ * first value is returned. If no value is associated, -1 is returned.
+ *
+ * Returns: the value associated with the key as an int64, or -1.
+ *
+ * Since: 0.2.1
+ */
gint64 osinfo_entity_get_param_value_int64(OsinfoEntity *entity,
const gchar *key)
{
return osinfo_entity_get_param_value_int64_with_default(entity, key, -1);
}
+/**
+ * osinfo_entity_get_param_value_int64_with_default:
+ * @entity: an #OsinfoEntity containing the parameters
+ * @key: the name of the key
+ * @default_value: the value to be returned in case there's no value
+ * associated with the @key
+ *
+ * Retrieve the parameter value associated with a named key as an
+ * int64. If multiple values are stored against the key, only the
+ * first value is returned. If no value is associated, @default_value
+ * is returned.
+ *
+ * Returns: the value associated with the key as an int64, or
+ * @default_value
+ *
+ * Since: 0.2.1
+ */
gint64 osinfo_entity_get_param_value_int64_with_default(OsinfoEntity *entity,
const gchar *key,
gint64 default_value)
diff --git a/osinfo/osinfo_install_config_param.c
b/osinfo/osinfo_install_config_param.c
index 187569f..ab854b3 100644
--- a/osinfo/osinfo_install_config_param.c
+++ b/osinfo/osinfo_install_config_param.c
@@ -253,6 +253,8 @@ OsinfoInstallConfigParamPolicy
osinfo_install_config_param_get_policy(OsinfoInst
*
* Returns: (transfer none): TRUE
[Libosinfo] [libosinfo PATCH 08/20] Add "Since: 0.2.3" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Together with this change, documentation has been added to the functions
missing them.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_datamap.c | 39
osinfo/osinfo_datamaplist.c | 2 ++
osinfo/osinfo_db.c | 7 +
osinfo/osinfo_install_config_paramlist.c | 2 ++
osinfo/osinfo_install_script.c | 4 +++
osinfo/osinfo_media.c| 4 +++
6 files changed, 58 insertions(+)
diff --git a/osinfo/osinfo_datamap.c b/osinfo/osinfo_datamap.c
index 05e4631..f8f81a9 100644
--- a/osinfo/osinfo_datamap.c
+++ b/osinfo/osinfo_datamap.c
@@ -85,6 +85,16 @@ osinfo_datamap_init(OsinfoDatamap *list)
}
+/**
+ * osinfo_datamap_new:
+ * @id: the unique identifier
+ *
+ * Construct a new datamapa that is initially empty.
+ *
+ * Returns: (transfer full): an empty datamap
+ *
+ * Since: 0.2.3
+ */
OsinfoDatamap *osinfo_datamap_new(const gchar *id)
{
return g_object_new(OSINFO_TYPE_DATAMAP,
@@ -93,6 +103,17 @@ OsinfoDatamap *osinfo_datamap_new(const gchar *id)
}
+/**
+ * osinfo_datamap_insert:
+ * @map: the OS datamap
+ * @inval: the input value
+ * @outval: the output value
+ *
+ * Adds the input value and the output value associated to it to
+ * the @map.
+ *
+ * Since: 0.2.3
+ */
void osinfo_datamap_insert(OsinfoDatamap *map,
const gchar *inval,
const gchar *outval)
@@ -108,12 +129,30 @@ void osinfo_datamap_insert(OsinfoDatamap *map,
g_hash_table_insert(map->priv->reverse_map, dup_outval, dup_inval);
}
+/**
+ * osinfo_datamap_lookup:
+ * @map: the OS datamap
+ * @inval: the input value
+ *
+ * Returns the output value with which @inval is associated to.
+ *
+ * Since: 0.2.3
+ */
const gchar *osinfo_datamap_lookup(OsinfoDatamap *map,
const gchar *inval)
{
return g_hash_table_lookup(map->priv->map, inval);
}
+/**
+ * osinfo_datamap_reverse_lookup:
+ * @map: the OS datamap
+ * @outval: the output value
+ *
+ * Returns the input value with which @outval is associated to.
+ *
+ * Since: 0.2.3
+ */
const gchar *osinfo_datamap_reverse_lookup(OsinfoDatamap *map,
const gchar *outval)
{
diff --git a/osinfo/osinfo_datamaplist.c b/osinfo/osinfo_datamaplist.c
index 1e45756..e3593b7 100644
--- a/osinfo/osinfo_datamaplist.c
+++ b/osinfo/osinfo_datamaplist.c
@@ -73,6 +73,8 @@ osinfo_datamaplist_init(OsinfoDatamapList *list)
* Construct a new install_datamap list that is initially empty.
*
* Returns: (transfer full): an empty install_datamap list
+ *
+ * Since: 0.2.3
*/
OsinfoDatamapList *osinfo_datamaplist_new(void)
{
diff --git a/osinfo/osinfo_db.c b/osinfo/osinfo_db.c
index 29f40b5..a2fc8bc 100644
--- a/osinfo/osinfo_db.c
+++ b/osinfo/osinfo_db.c
@@ -261,6 +261,8 @@ OsinfoDeployment *osinfo_db_get_deployment(OsinfoDb *db,
const gchar *id)
* @id: the unique operating system identifier
*
* Returns: (transfer none): the install datamap, or NULL if none is found
+ *
+ * Since: 0.2.3
*/
OsinfoDatamap *osinfo_db_get_datamap(OsinfoDb *db, const gchar *id)
{
@@ -402,6 +404,8 @@ OsinfoDeploymentList
*osinfo_db_get_deployment_list(OsinfoDb *db)
* @db: the database
*
* Returns: (transfer full): the list of install datamaps
+ *
+ * Since: 0.2.3
*/
OsinfoDatamapList *osinfo_db_get_datamap_list(OsinfoDb *db)
{
@@ -498,6 +502,7 @@ void osinfo_db_add_deployment(OsinfoDb *db,
OsinfoDeployment *deployment)
* @db: the database
* @datamap: (transfer none): an install datamap
*
+ * Since: 0.2.3
*/
void osinfo_db_add_datamap(OsinfoDb *db, OsinfoDatamap *datamap)
{
@@ -753,6 +758,8 @@ static void fill_media(OsinfoDb *db, OsinfoMedia *media,
* properties will be set.
*
* Returns: TRUE if @media was found in @db, FALSE otherwise
+ *
+ * Since: 0.2.3
*/
gboolean osinfo_db_identify_media(OsinfoDb *db, OsinfoMedia *media)
{
diff --git a/osinfo/osinfo_install_config_paramlist.c
b/osinfo/osinfo_install_config_paramlist.c
index 9925cbf..d5390ed 100644
--- a/osinfo/osinfo_install_config_paramlist.c
+++ b/osinfo/osinfo_install_config_paramlist.c
@@ -75,6 +75,8 @@
osinfo_install_config_paramlist_init(OsinfoInstallConfigParamList *list)
* Construct a new install_config_param list that is initially empty.
*
* Returns: (transfer full): an empty install_config_param list
+ *
+ * Since: 0.2.3
*/
OsinfoInstallConfigParamList *osinfo_install_config_paramlist_new(void)
{
diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index 7e242c9..934f25c 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -368,6 +368,8 @@ GList
*osinfo_install_script_get_config_param_list(OsinfoInstallScript *script)
*
* Returns:
[Libosinfo] [libosinfo PATCH 13/20] Add "Since: 0.2.10" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_install_script.c | 2 ++
osinfo/osinfo_install_script.h | 1 +
2 files changed, 3 insertions(+)
diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index 173e9c6..9ae6712 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -1918,6 +1918,8 @@ int
osinfo_install_script_get_post_install_drivers_signing_req(OsinfoInstallScri
*
* Returns: (type OsinfoInstallScriptInjectionMethod): bitwise-or of
* supported methods for install script injection.
+ *
+ * Since: 0.2.10
*/
unsigned int osinfo_install_script_get_injection_methods(OsinfoInstallScript
*script)
{
diff --git a/osinfo/osinfo_install_script.h b/osinfo/osinfo_install_script.h
index f3fa5ba..ccd6cbc 100644
--- a/osinfo/osinfo_install_script.h
+++ b/osinfo/osinfo_install_script.h
@@ -118,6 +118,7 @@ typedef enum {
/**
* OsinfoInstallScriptInjectionMethod:
+ * Since: 0.2.10
* @OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_CDROM: Support injection of the
* installation script trough a CD-ROM.
* @OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_DISK: Support injection of the
--
2.21.0
___
Libosinfo mailing list
Libosinfo@redhat.com
https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 01/20] Add "Since: 0.0.3" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_media.c | 4
1 file changed, 4 insertions(+)
diff --git a/osinfo/osinfo_media.c b/osinfo/osinfo_media.c
index 3bedeb4..9592f04 100644
--- a/osinfo/osinfo_media.c
+++ b/osinfo/osinfo_media.c
@@ -1557,6 +1557,8 @@ const gchar *osinfo_media_get_initrd_path(OsinfoMedia
*media)
* Whether @media provides an installer for an OS.
*
* Returns: #TRUE if media is installer, #FALSE otherwise
+ *
+ * Since: 0.0.3
*/
gboolean osinfo_media_get_installer(OsinfoMedia *media)
{
@@ -1571,6 +1573,8 @@ gboolean osinfo_media_get_installer(OsinfoMedia *media)
* Whether @media can boot directly an OS without any installations.
*
* Returns: #TRUE if media is live, #FALSE otherwise
+ *
+ * Since: 0.0.3
*/
gboolean osinfo_media_get_live(OsinfoMedia *media)
{
--
2.21.0
___
Libosinfo mailing list
Libosinfo@redhat.com
https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 15/20] Add "Since: 0.2.12" to the documentation
Let's add the "Since: ..." information as part of the function's documentation. It helps developers reading our docs to easily figure out when a function has been introduced. Signed-off-by: Fabiano Fidêncio --- osinfo/osinfo_install_script.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c index 8166a70..3d8c502 100644 --- a/osinfo/osinfo_install_script.c +++ b/osinfo/osinfo_install_script.c @@ -1777,6 +1777,8 @@ gchar *osinfo_install_script_generate_command_line(OsinfoInstallScript *script, * #osinfo_db_identify_media() before calling this function. * * Returns: (transfer full): The generated command line string, NULL otherwise. + * + * Since: 0.2.12 */ gchar *osinfo_install_script_generate_command_line_for_media(OsinfoInstallScript *script, OsinfoMedia *media, -- 2.21.0 ___ Libosinfo mailing list Libosinfo@redhat.com https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 03/20] Add "Since: 0.0.6" to the documentation
Let's add the "Since: ..." information as part of the function's documentation. It helps developers reading our docs to easily figure out when a function has been introduced. Signed-off-by: Fabiano Fidêncio --- osinfo/osinfo_os.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/osinfo/osinfo_os.c b/osinfo/osinfo_os.c index afd84b0..82af6b7 100644 --- a/osinfo/osinfo_os.c +++ b/osinfo/osinfo_os.c @@ -408,6 +408,8 @@ OsinfoDeviceList *osinfo_os_get_all_devices(OsinfoOs *os, OsinfoFilter *filter) * @os supports, for which the value of @property is @value. * * Returns: (transfer full): The found devices + * + * Since: 0.0.6 */ OsinfoDeviceList *osinfo_os_get_devices_by_property(OsinfoOs *os, const gchar *property, -- 2.21.0 ___ Libosinfo mailing list Libosinfo@redhat.com https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 12/20] Add "Since: 0.2.9" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Together with this change, documentation has been added to the functions
missing them.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_media.c | 2 ++
osinfo/osinfo_os.c | 6 ++
osinfo/osinfo_os.h | 1 +
osinfo/osinfo_os_variant.c | 13 +
osinfo/osinfo_os_variantlist.c | 2 ++
5 files changed, 24 insertions(+)
diff --git a/osinfo/osinfo_media.c b/osinfo/osinfo_media.c
index ccfc704..42a8f37 100644
--- a/osinfo/osinfo_media.c
+++ b/osinfo/osinfo_media.c
@@ -1641,6 +1641,8 @@ void osinfo_media_set_os(OsinfoMedia *media, OsinfoOs *os)
* Gets the variants of the associated operating system.
*
* Returns: (transfer full): the operating system variant, or NULL
+ *
+ * Since: 0.2.9
*/
OsinfoOsVariantList *osinfo_media_get_os_variants(OsinfoMedia *media)
{
diff --git a/osinfo/osinfo_os.c b/osinfo/osinfo_os.c
index 61f2c69..7c69bfb 100644
--- a/osinfo/osinfo_os.c
+++ b/osinfo/osinfo_os.c
@@ -620,6 +620,8 @@ const gchar *osinfo_os_get_distro(OsinfoOs *os)
* Use this to determine the release status of the @os.
*
* Returns: (type OsinfoReleaseStatus): release status of @os.
+ *
+ * Since: 0.2.9
*/
int osinfo_os_get_release_status(OsinfoOs *os)
{
@@ -744,6 +746,8 @@ void osinfo_os_add_image(OsinfoOs *os, OsinfoImage *image)
* Gets all known variants of operating system @os.
*
* Returns: (transfer full): A list of variants
+ *
+ * Since: 0.2.9
*/
OsinfoOsVariantList *osinfo_os_get_variant_list(OsinfoOs *os)
{
@@ -762,6 +766,8 @@ OsinfoOsVariantList *osinfo_os_get_variant_list(OsinfoOs
*os)
* @variant: (transfer none): the variant to add
*
* Adds a variant @variant to operating system @os.
+ *
+ * Since: 0.2.9
*/
void osinfo_os_add_variant(OsinfoOs *os, OsinfoOsVariant *variant)
{
diff --git a/osinfo/osinfo_os.h b/osinfo/osinfo_os.h
index 6207a53..2bec1c8 100644
--- a/osinfo/osinfo_os.h
+++ b/osinfo/osinfo_os.h
@@ -86,6 +86,7 @@ struct _OsinfoOsClass
/**
* OsinfoReleaseStatus:
+ * Since: 0.2.9
* @OSINFO_RELEASE_STATUS_RELEASED: A released OS.
* @OSINFO_RELEASE_STATUS_SNAPSHOT: A continuous integration snapshot and not
* an actual released product yet. For example, gnome-continuous images for
diff --git a/osinfo/osinfo_os_variant.c b/osinfo/osinfo_os_variant.c
index 3320209..a623146 100644
--- a/osinfo/osinfo_os_variant.c
+++ b/osinfo/osinfo_os_variant.c
@@ -125,6 +125,17 @@ osinfo_os_variant_init(OsinfoOsVariant *variant)
variant->priv = OSINFO_OS_VARIANT_GET_PRIVATE(variant);
}
+/**
+ * osinfo_os_variant_new:
+ *
+ * @id: the id of the os variant to be created
+ *
+ * Creates a new os variant
+ *
+ * Returns: (transfer full): An os variant entity
+ *
+ * Since: 0.2.9
+ */
OsinfoOsVariant *osinfo_os_variant_new(const gchar *id)
{
OsinfoOsVariant *variant;
@@ -143,6 +154,8 @@ OsinfoOsVariant *osinfo_os_variant_new(const gchar *id)
* The name of the @variant
*
* Returns: (transfer none): the name, or NULL
+ *
+ * Since: 0.2.9
*/
const gchar *osinfo_os_variant_get_name(OsinfoOsVariant *variant)
{
diff --git a/osinfo/osinfo_os_variantlist.c b/osinfo/osinfo_os_variantlist.c
index 4c8a249..73cfb9f 100644
--- a/osinfo/osinfo_os_variantlist.c
+++ b/osinfo/osinfo_os_variantlist.c
@@ -62,6 +62,8 @@ osinfo_os_variantlist_init(OsinfoOsVariantList *list)
* Construct a new install_variant list that is initially empty.
*
* Returns: (transfer full): an empty install_variant list
+ *
+ * Since: 0.2.9
*/
OsinfoOsVariantList *osinfo_os_variantlist_new(void)
{
--
2.21.0
___
Libosinfo mailing list
Libosinfo@redhat.com
https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 09/20] Add "Since: 0.2.6" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_device_driver.c | 2 ++
osinfo/osinfo_install_config.c | 4
osinfo/osinfo_install_script.c | 4
osinfo/osinfo_install_script.h | 1 +
4 files changed, 11 insertions(+)
diff --git a/osinfo/osinfo_device_driver.c b/osinfo/osinfo_device_driver.c
index 04ab5d8..a0e6222 100644
--- a/osinfo/osinfo_device_driver.c
+++ b/osinfo/osinfo_device_driver.c
@@ -188,6 +188,8 @@ void osinfo_device_driver_add_device(OsinfoDeviceDriver
*driver,
* before these device drivers could be installed on their OS.
*
* Returns: TRUE if @driver is signed, FALSE otherwise.
+ *
+ * Since: 0.2.6
*/
gboolean osinfo_device_driver_get_signed(OsinfoDeviceDriver *driver)
{
diff --git a/osinfo/osinfo_install_config.c b/osinfo/osinfo_install_config.c
index 05eff36..2bd5e4b 100644
--- a/osinfo/osinfo_install_config.c
+++ b/osinfo/osinfo_install_config.c
@@ -882,6 +882,8 @@ const gchar
*osinfo_install_config_get_post_install_drivers_location(OsinfoInsta
* If a script requires drivers to be signed, this function can be used to
* disable that security feature. WARNING: Disabling driver signing may very
* well mean disabling it permanently.
+ *
+ * Since: 0.2.6
*/
void osinfo_install_config_set_driver_signing(OsinfoInstallConfig *config,
gboolean signing)
@@ -898,6 +900,8 @@ void
osinfo_install_config_set_driver_signing(OsinfoInstallConfig *config,
* Returns: %TRUE if driver signing is currently enabled, %FALSE otherwise, see
* #osinfo_install_config_set_driver_signing() for more details about driver
* signing.
+ *
+ * Since: 0.2.6
*/
gboolean osinfo_install_config_get_driver_signing(OsinfoInstallConfig *config)
{
diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index 934f25c..826b9e2 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -1868,6 +1868,8 @@ gboolean
osinfo_install_script_get_can_post_install_drivers(OsinfoInstallScript
* this function retrieves the requirement about signed status of drivers.
*
* Returns: (type OsinfoDeviceDriverSigningReq):
+ *
+ * Since: 0.2.6
*/
int
osinfo_install_script_get_pre_install_drivers_signing_req(OsinfoInstallScript
*script)
{
@@ -1886,6 +1888,8 @@ int
osinfo_install_script_get_pre_install_drivers_signing_req(OsinfoInstallScrip
* function retrieves the requirement about signed status of drivers.
*
* Returns: (type OsinfoDeviceDriverSigningReq):
+ *
+ * Since: 0.2.6
*/
int
osinfo_install_script_get_post_install_drivers_signing_req(OsinfoInstallScript
*script)
{
diff --git a/osinfo/osinfo_install_script.h b/osinfo/osinfo_install_script.h
index e8abe25..f3fa5ba 100644
--- a/osinfo/osinfo_install_script.h
+++ b/osinfo/osinfo_install_script.h
@@ -95,6 +95,7 @@ typedef enum {
/**
* OsinfoDeviceDriverSigningReq:
+ * Since: 0.2.6
* @OSINFO_DEVICE_DRIVER_SIGNING_REQ_NONE: Script do not require device drivers
* to be signed.
* @OSINFO_DEVICE_DRIVER_SIGNING_REQ_STRICT: Script must only be given signed
--
2.21.0
___
Libosinfo mailing list
Libosinfo@redhat.com
https://www.redhat.com/mailman/listinfo/libosinfo
[Libosinfo] [libosinfo PATCH 05/20] Add "Since: 0.2.0" to the documentation
Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.
Together with this change, documentation has been added to the functions
missing them.
Signed-off-by: Fabiano Fidêncio
---
osinfo/osinfo_db.c | 5 +
osinfo/osinfo_entity.c | 25
osinfo/osinfo_install_config.c | 193 ++-
osinfo/osinfo_install_config_param.c | 6 +
osinfo/osinfo_install_script.c | 88 +++-
osinfo/osinfo_install_scriptlist.c | 10 ++
osinfo/osinfo_os.c | 13 ++
7 files changed, 335 insertions(+), 5 deletions(-)
diff --git a/osinfo/osinfo_db.c b/osinfo/osinfo_db.c
index 43b66eb..29f40b5 100644
--- a/osinfo/osinfo_db.c
+++ b/osinfo/osinfo_db.c
@@ -277,6 +277,8 @@ OsinfoDatamap *osinfo_db_get_datamap(OsinfoDb *db, const
gchar *id)
* @id: the unique operating system identifier
*
* Returns: (transfer none): the install script, or NULL if none is found
+ *
+ * Since: 0.2.0
*/
OsinfoInstallScript *osinfo_db_get_install_script(OsinfoDb *db, const gchar
*id)
{
@@ -417,6 +419,8 @@ OsinfoDatamapList *osinfo_db_get_datamap_list(OsinfoDb *db)
* @db: the database
*
* Returns: (transfer full): the list of install scripts
+ *
+ * Since: 0.2.0
*/
OsinfoInstallScriptList *osinfo_db_get_install_script_list(OsinfoDb *db)
{
@@ -509,6 +513,7 @@ void osinfo_db_add_datamap(OsinfoDb *db, OsinfoDatamap
*datamap)
* @db: the database
* @script: (transfer none): an install script
*
+ * Since: 0.2.0
*/
void osinfo_db_add_install_script(OsinfoDb *db, OsinfoInstallScript *script)
{
diff --git a/osinfo/osinfo_entity.c b/osinfo/osinfo_entity.c
index f0bfb67..f634d78 100644
--- a/osinfo/osinfo_entity.c
+++ b/osinfo/osinfo_entity.c
@@ -187,6 +187,18 @@ void osinfo_entity_set_param(OsinfoEntity *entity, const
gchar *key, const gchar
}
+/**
+ * osinfo_entity_set_param_boolean:
+ * @entity: an #OsinfoEntity containing the parameters
+ * @key: the name of the key
+ * @value: the boolean value to be associated with that key
+ *
+ * Sets a new parameter against the entity. If the key already
+ * has a value associated with it, the existing value will be
+ * cleared.
+ *
+ * Since: 0.2.0
+ */
void osinfo_entity_set_param_boolean(OsinfoEntity *entity, const gchar *key,
gboolean value)
{
osinfo_entity_set_param(entity, key, value ? "true" : "false");
@@ -331,6 +343,19 @@ static gboolean str_to_bool(const char *str)
return (g_strcmp0("true", str) == 0 || g_strcmp0("yes", str) == 0);
}
+/**
+ * osinfo_entity_get_param_value_boolean:
+ * @entity: an #OsinfoEntity containing the parameters
+ * @key: the name of the key
+ *
+ * Retrieve the parameter value associated with a named key as a
+ * boolean. If multiple values are stored against the key, only the
+ * first value is returned. If no value is associated, FALSE is returned
+ *
+ * Returns: the value associated with the key as a boolean, or FALSE
+ *
+ * Since: 0.2.0
+ */
gboolean osinfo_entity_get_param_value_boolean(OsinfoEntity *entity, const
gchar *key)
{
const gchar *value = osinfo_entity_get_param_value(entity, key);
diff --git a/osinfo/osinfo_install_config.c b/osinfo/osinfo_install_config.c
index 4a01a81..e8a181e 100644
--- a/osinfo/osinfo_install_config.c
+++ b/osinfo/osinfo_install_config.c
@@ -106,6 +106,7 @@ osinfo_install_config_init(OsinfoInstallConfig *config)
* Returns: (transfer full): an install configuration with default
* values
*
+ * Since: 0.2.0
*/
OsinfoInstallConfig *osinfo_install_config_new(const gchar *id)
{
@@ -114,6 +115,17 @@ OsinfoInstallConfig *osinfo_install_config_new(const gchar
*id)
NULL);
}
+/**
+ * osinfo_install_config_set_hardware_arch:
+ * @config: the install config
+ * @arch: the hardware architecture
+ *
+ * Sets the #OSINFO_INSTALL_CONFIG_PROP_HARDWARE_ARCH parameter.
+ *
+ * The list of valid architectures are part of osinfo.rng schema
+ *
+ * Since: 0.2.0
+ */
void osinfo_install_config_set_hardware_arch(OsinfoInstallConfig *config,
const gchar *arch)
{
@@ -138,6 +150,8 @@ const gchar
*osinfo_install_config_get_hardware_arch(OsinfoInstallConfig *config
*
* The expected format of this string is the same as
* #osinfo_install_config_set_l10n_language function's 'language' parameter.
+ *
+ * Since: 0.2.0
*/
void osinfo_install_config_set_l10n_keyboard(OsinfoInstallConfig *config,
const gchar *keyboard)
@@ -147,7 +161,15 @@ void
osinfo_install_config_set_l10n_keyboard(OsinfoInstallConfig *config,
keyboard);
}
-
+/**
+ * osinfo_install_config_get_l10n_keyboard:
+ * @config: the install config
+ *
+ * Returns: The value of #OSINFO_INSTALL_CONFIG_PROP_L10N_KEYBOARD parameter,
+ * or NULL.
+ *
+ * Since: 0.2.0
+ */
const
