[Libosinfo] [PATCH 05/10] Recommend osinfo_install_script_generate_*for_media()

[Zeeshan Ali (Khattak)]

Recommend the use of the new script generation API that takes an
identified media object as arugment rather than OS, in the docs.
---
 osinfo/osinfo_install_script.c | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index 66593bb..5b1ee4f 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -977,6 +977,10 @@ static void osinfo_install_script_generate_async_common(OsinfoInstallScript *scr
  * Asynchronous variant of #osinfo_install_script_generate(). From the callback,
  * call #osinfo_install_script_generate_finish() to conclude this call and get
  * the generated script.
+ *
+ * If you are generating the script for a specific media, it is highly
+ * recommended that you use #osinfo_install_script_generate_for_media_async()
+ * instead.
  */
 void osinfo_install_script_generate_async(OsinfoInstallScript *script,
                                           OsinfoOs *os,
@@ -1154,6 +1158,9 @@ static void osinfo_install_script_generate_done(GObject *src,
  * Creates an install script.
  *
  * Returns: (transfer full): the script as string.
+ *
+ * If you are generating the script for a specific media, it is highly
+ * recommended that you use #osinfo_install_script_generate_for_media() instead.
  */
 gchar *osinfo_install_script_generate(OsinfoInstallScript *script,
                                       OsinfoOs *os,
@@ -1387,6 +1394,10 @@ static void osinfo_install_script_generate_output_async_common(OsinfoInstallScri
  * Asynchronous variant of #osinfo_install_script_generate_output(). From the
  * callback, call #osinfo_install_script_generate_output_finish() to conclude
  * this call and get the generated script.
+ *
+ * If you are generating the script for a specific media, it is highly
+ * recommended that you use
+ * #osinfo_install_script_generate_output_for_media_async() instead.
  */
 void osinfo_install_script_generate_output_async(OsinfoInstallScript *script,
                                                  OsinfoOs *os,
@@ -1464,6 +1475,10 @@ static GFile *osinfo_install_script_generate_output_common(OsinfoInstallScript *
  * Creates an install script that is written to the returned file.
  *
  * Returns: (transfer full): a file containing the script
+ *
+ * If you are generating the script for a specific media, it is highly
+ * recommended that you use #osinfo_install_script_generate_output_for_media()
+ * instead.
  */
 GFile *osinfo_install_script_generate_output(OsinfoInstallScript *script,
                                              OsinfoOs *os,
@@ -1561,6 +1576,10 @@ GFile *osinfo_install_script_generate_output_for_media(OsinfoInstallScript *scri
  * (http://wiki.qemu.org/download/qemu-doc.html#direct_005flinux_005fboot)
  * the OS in order to pass the needed commandline to it.
  *
+ * If you are generating the command line for a specific media, it is highly
+ * recommended that you use
+ * #osinfo_install_script_generate_command_line_for_media() instead.
+ *
  * Returns: (transfer full): The generated command line string, NULL otherwise.
  */
 gchar *osinfo_install_script_generate_command_line(OsinfoInstallScript *script,
-- 
2.1.0