[glib] Don't use <envar> in docs

From: Matthias Clasen <matthiasc src gnome org>
To: commits-list gnome org
Cc:
Subject: [glib] Don't use <envar> in docs
Date: Thu, 6 Feb 2014 00:33:29 +0000 (UTC)
commit 111803030d54b192ca1edd25bbde90130eaff2a9
Author: Matthias Clasen <mclasen redhat com>
Date:   Wed Feb 5 19:32:41 2014 -0500

    Don't use <envar> in docs
    
    Switch to simpler markdown, `foo`.

 gio/gappinfo.c                |   22 ++++++++---------
 gio/gapplicationcommandline.c |    6 ++--
 gio/gdesktopappinfo.c         |   12 ++++----
 gio/giomodule.c               |    6 ++--
 gio/gresource.c               |   11 ++++----
 gio/gsettingsbackend.c        |    4 +-
 gio/gsettingsschema.c         |    5 +--
 gio/gtestdbus.c               |   14 ++++++----
 glib/gcharset.c               |    6 ++--
 glib/gconvert.c               |   37 ++++++++++++++---------------
 glib/gfileutils.c             |    6 ++--
 glib/ggettext.c               |    2 +-
 glib/gkeyfile.c               |    5 ++-
 glib/glib-init.c              |    2 +-
 glib/gmessages.c              |   28 +++++++++++-----------
 glib/grand.c                  |    7 ++---
 glib/gspawn.c                 |   38 +++++++++++++++---------------
 glib/gtestutils.c             |    4 +-
 glib/gtimezone.c              |   39 +++++++++++++++---------------
 glib/gutils.c                 |   52 ++++++++++++++++++++--------------------
 20 files changed, 152 insertions(+), 154 deletions(-)
---
diff --git a/gio/gappinfo.c b/gio/gappinfo.c
index abb6193..266b22c 100644
--- a/gio/gappinfo.c
+++ b/gio/gappinfo.c
@@ -538,17 +538,16 @@ g_app_info_get_icon (GAppInfo *appinfo)
  * g_app_info_launch_uris() instead.
  *
  * The launched application inherits the environment of the launching
- * process, but it can be modified with g_app_launch_context_setenv() and
- * g_app_launch_context_unsetenv().
+ * process, but it can be modified with g_app_launch_context_setenv()
+ * and g_app_launch_context_unsetenv().
  *
- * On UNIX, this function sets the <envar>GIO_LAUNCHED_DESKTOP_FILE</envar>
+ * On UNIX, this function sets the `GIO_LAUNCHED_DESKTOP_FILE`
  * environment variable with the path of the launched desktop file and
- * <envar>GIO_LAUNCHED_DESKTOP_FILE_PID</envar> to the process
- * id of the launched process. This can be used to ignore
- * <envar>GIO_LAUNCHED_DESKTOP_FILE</envar>, should it be inherited
- * by further processes. The <envar>DISPLAY</envar> and
- * <envar>DESKTOP_STARTUP_ID</envar> environment variables are also
- * set, based on information provided in @launch_context.
+ * `GIO_LAUNCHED_DESKTOP_FILE_PID` to the process id of the launched
+ * process. This can be used to ignore `GIO_LAUNCHED_DESKTOP_FILE`,
+ * should it be inherited by further processes. The `DISPLAY` and
+ * `DESKTOP_STARTUP_ID` environment variables are also set, based
+ * on information provided in @launch_context.
  *
  * Returns: %TRUE on successful launch, %FALSE otherwise.
  **/
@@ -951,7 +950,7 @@ g_app_launch_context_get_environment (GAppLaunchContext *context)
  *
  * Gets the display string for the @context. This is used to ensure new
  * applications are started on the same display as the launching
- * application, by setting the <envar>DISPLAY</envar> environment variable.
+ * application, by setting the `DISPLAY` environment variable.
  *
  * Returns: a display string for the display.
  */
@@ -980,8 +979,7 @@ g_app_launch_context_get_display (GAppLaunchContext *context,
  * @files: (element-type GFile): a #GList of of #GFile objects
  * 
  * Initiates startup notification for the application and returns the
- * <envar>DESKTOP_STARTUP_ID</envar> for the launched operation,
- * if supported.
+ * `DESKTOP_STARTUP_ID` for the launched operation, if supported.
  *
  * Startup notification IDs are defined in the <ulink
  * url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt";>
diff --git a/gio/gapplicationcommandline.c b/gio/gapplicationcommandline.c
index b0c76e5..d804322 100644
--- a/gio/gapplicationcommandline.c
+++ b/gio/gapplicationcommandline.c
@@ -67,9 +67,9 @@
  *
  * The main use for #GApplicationCommandLine (and the
  * #GApplication::command-line signal) is 'Emacs server' like use cases:
- * You can set the <envar>EDITOR</envar> environment variable to have
- * e.g. git use your favourite editor to edit commit messages, and if you
- * already have an instance of the editor running, the editing will happen
+ * You can set the `EDITOR` environment variable to have e.g. git use
+ * your favourite editor to edit commit messages, and if you already
+ * have an instance of the editor running, the editing will happen
  * in the running instance, instead of opening a new one. An important
  * aspect of this use case is that the process that gets started by git
  * does not return until the editing is done.
diff --git a/gio/gdesktopappinfo.c b/gio/gdesktopappinfo.c
index caccef0..e009667 100644
--- a/gio/gdesktopappinfo.c
+++ b/gio/gdesktopappinfo.c
@@ -1306,12 +1306,12 @@ g_desktop_app_info_new_from_filename (const char *filename)
  *
  * A desktop file id is the basename of the desktop file, including the
  * .desktop extension. GIO is looking for a desktop file with this name
- * in the <filename>applications</filename> subdirectories of the XDG data
- * directories (i.e. the directories specified in the
- * <envar>XDG_DATA_HOME</envar> and <envar>XDG_DATA_DIRS</envar> environment
- * variables). GIO also supports the prefix-to-subdirectory mapping that is
- * described in the <ulink url="http://standards.freedesktop.org/menu-spec/latest/";>Menu Spec</ulink>
- * (i.e. a desktop id of kde-foo.desktop will match
+ * in the <filename>applications</filename> subdirectories of the XDG
+ * data directories (i.e. the directories specified in the `XDG_DATA_HOME`
+ * and `XDG_DATA_DIRS` environment variables). GIO also supports the
+ * prefix-to-subdirectory mapping that is described in the
+ * <ulink url="http://standards.freedesktop.org/menu-spec/latest/";>Menu
+ * Spec</ulink> (i.e. a desktop id of kde-foo.desktop will match
  * <filename>/usr/share/applications/kde/foo.desktop</filename>).
  *
  * Returns: a new #GDesktopAppInfo, or %NULL if no desktop file with that id
diff --git a/gio/giomodule.c b/gio/giomodule.c
index 056a899..39989f3 100644
--- a/gio/giomodule.c
+++ b/gio/giomodule.c
@@ -106,10 +106,10 @@
  *  You are expected to run this command after installing a
  *  GIO module.
  *
- *  The <envar>GIO_EXTRA_MODULES</envar> environment variable can be
- *  used to specify additional directories to automatically load modules
+ *  The `GIO_EXTRA_MODULES` environment variable can be used to
+ *  specify additional directories to automatically load modules
  *  from. This environment variable has the same syntax as the
- *  <envar>PATH</envar>. If two modules have the same base name in different
+ *  `PATH`. If two modules have the same base name in different
  *  directories, then the latter one will be ignored. If additional
  *  directories are specified GIO will load modules from the built-in
  *  directory last.
diff --git a/gio/gresource.c b/gio/gresource.c
index 009da84..646708a 100644
--- a/gio/gresource.c
+++ b/gio/gresource.c
@@ -66,15 +66,16 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref)
  * <literal>preprocess</literal> attribute to a comma-separated list of preprocessing options.
  * The only options currently supported are:
  *
- * <literal>xml-stripblanks</literal> which will use the xmllint command to strip
- * ignorable whitespace from the xml file. For this to work, the <envar>XMLLINT</envar>
- * environment variable must be set to the full path to the xmllint executable, or xmllint
- * must be in the PATH; otherwise the preprocessing step is skipped.
+ * <literal>xml-stripblanks</literal> which will use the xmllint command
+ * to strip ignorable whitespace from the xml file. For this to work,
+ * the `XMLLINT` environment variable must be set to the full path to
+ * the xmllint executable, or xmllint must be in the `PATH`; otherwise
+ * the preprocessing step is skipped.
  *
  * <literal>to-pixdata</literal> which will use the gdk-pixbuf-pixdata command to convert
  * images to the GdkPixdata format, which allows you to create pixbufs directly using the data inside
  * the resource file, rather than an (uncompressed) copy if it. For this, the gdk-pixbuf-pixdata
- * program must be in the PATH, or the <envar>GDK_PIXBUF_PIXDATA</envar> environment variable must be
+ * program must be in the PATH, or the `GDK_PIXBUF_PIXDATA` environment variable must be
  * set to the full path to the gdk-pixbuf-pixdata executable; otherwise the resource compiler will
  * abort.
  *
diff --git a/gio/gsettingsbackend.c b/gio/gsettingsbackend.c
index 9c96401..0643da5 100644
--- a/gio/gsettingsbackend.c
+++ b/gio/gsettingsbackend.c
@@ -1007,8 +1007,8 @@ g_settings_backend_verify (gpointer impl)
  * g_settings_backend_get_default:
  *
  * Returns the default #GSettingsBackend. It is possible to override
- * the default by setting the <envar>GSETTINGS_BACKEND</envar>
- * environment variable to the name of a settings backend.
+ * the default by setting the `GSETTINGS_BACKEND` environment variable
+ * to the name of a settings backend.
  *
  * The user gets a reference to the backend.
  *
diff --git a/gio/gsettingsschema.c b/gio/gsettingsschema.c
index ba14203..29d6f04 100644
--- a/gio/gsettingsschema.c
+++ b/gio/gsettingsschema.c
@@ -363,9 +363,8 @@ initialise_schema_sources (void)
  *
  * The returned source may actually consist of multiple schema sources
  * from different directories, depending on which directories were given
- * in <envar>XDG_DATA_DIRS</envar> and
- * <envar>GSETTINGS_SCHEMA_DIR</envar>.  For this reason, all lookups
- * performed against the default source should probably be done
+ * in `XDG_DATA_DIRS` and `GSETTINGS_SCHEMA_DIR`. For this reason, all
+ * lookups performed against the default source should probably be done
  * recursively.
  *
  * Returns: (transfer none): the default schema source
diff --git a/gio/gtestdbus.c b/gio/gtestdbus.c
index 9d784b7..012c7e0 100644
--- a/gio/gtestdbus.c
+++ b/gio/gtestdbus.c
@@ -371,12 +371,14 @@ _g_test_watcher_remove_pid (GPid pid)
  * and schema files are not yet installed, or worse; there is an older version of the
  * schema file sitting in the install location).
  *
- * Most of the time we can work around these obstacles using the environment. Since the
- * environment is inherited by the D-Bus daemon created by #GTestDBus and then in turn
- * inherited by any services the D-Bus daemon activates, using the setup routine for your
- * fixture is a practical place to help sandbox your runtime environment. For the rather
- * typical GSettings case we can work around this by setting <envar>GSETTINGS_SCHEMA_DIR</envar> to the
- * in tree directory holding your schemas in the above fixture_setup() routine.
+ * Most of the time we can work around these obstacles using the
+ * environment. Since the environment is inherited by the D-Bus daemon
+ * created by #GTestDBus and then in turn inherited by any services the
+ * D-Bus daemon activates, using the setup routine for your fixture is
+ * a practical place to help sandbox your runtime environment. For the
+ * rather typical GSettings case we can work around this by setting
+ * `GSETTINGS_SCHEMA_DIR` to the in tree directory holding your schemas
+ * in the above fixture_setup() routine.
  *
  * The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved
  * by compiling the schemas locally as a step before running test cases, an autotools setup might
diff --git a/glib/gcharset.c b/glib/gcharset.c
index 82e3fc6..7b4208e 100644
--- a/glib/gcharset.c
+++ b/glib/gcharset.c
@@ -539,9 +539,9 @@ language_names_cache_free (gpointer data)
  * For example, if LANGUAGE=de:en_US, then the returned list is
  * "de", "en_US", "en", "C".
  *
- * This function consults the environment variables <envar>LANGUAGE</envar>,
- * <envar>LC_ALL</envar>, <envar>LC_MESSAGES</envar> and <envar>LANG</envar>
- * to find the list of locales specified by the user.
+ * This function consults the environment variables `LANGUAGE`, `LC_ALL`,
+ * `LC_MESSAGES` and `LANG` to find the list of locales specified by the
+ * user.
  *
  * Return value: (array zero-terminated=1) (transfer none): a %NULL-terminated array of strings owned by GLib
  *    that must not be modified or freed.
diff --git a/glib/gconvert.c b/glib/gconvert.c
index fc1c308..a835b79 100644
--- a/glib/gconvert.c
+++ b/glib/gconvert.c
@@ -108,7 +108,7 @@
  * want to instruct Glib to use that particular encoding for file
  * names rather than UTF-8. You can do this by specifying the
  * encoding for file names in the <link
- * linkend="G_FILENAME_ENCODING"><envar>G_FILENAME_ENCODING</envar></link>
+ * linkend="G_FILENAME_ENCODING">`G_FILENAME_ENCODING`</link>
  * environment variable. For example, if your installation uses
  * ISO-8859-1 for file names, you can put this in your
  * <filename>~/.profile</filename>:
@@ -118,7 +118,7 @@
  * Glib provides the functions g_filename_to_utf8() and
  * g_filename_from_utf8() to perform the necessary conversions.
  * These functions convert file names from the encoding specified
- * in <envar>G_FILENAME_ENCODING</envar> to UTF-8 and vice-versa.
+ * in `G_FILENAME_ENCODING` to UTF-8 and vice-versa.
  * <xref linkend="file-name-encodings-diagram"/> illustrates how
  * these functions are used to convert between UTF-8 and the
  * encoding for file names in the file system.
@@ -149,17 +149,17 @@
  *
  *    For example, the document window of a word processor could display
  *    "Unknown file name" in its title bar but still let the user save
- *    the file, as it would keep the raw file name internally. This can
- *    happen if the user has not set the <envar>G_FILENAME_ENCODING</envar>
- *    environment variable even though he has files whose names are not
- *    encoded in UTF-8.
+ *    the file, as it would keep the raw file name internally. This
+ *    can happen if the user has not set the `G_FILENAME_ENCODING`
+ *    environment variable even though he has files whose names are
+ *    not encoded in UTF-8.
  *
  * 3. If your user interface lets the user type a file name for saving
  *    or renaming, convert it to the encoding used for file names in
  *    the file system by using g_filename_from_utf8(). Pass the converted
  *    file name to functions like fopen(). If conversion fails, ask the
  *    user to enter a different file name. This can happen if the user
- *    types Japanese characters when <envar>G_FILENAME_ENCODING</envar>
+ *    types Japanese characters when `G_FILENAME_ENCODING`
  *    is set to <literal>ISO-8859-1</literal>, for example.
  */
 
@@ -982,24 +982,23 @@ filename_charset_cache_free (gpointer data)
  * representation of a filename, see g_filename_display_name().
  *
  * On Unix, the character sets are determined by consulting the
- * environment variables <envar>G_FILENAME_ENCODING</envar> and
- * <envar>G_BROKEN_FILENAMES</envar>. On Windows, the character set
- * used in the GLib API is always UTF-8 and said environment variables
- * have no effect.
+ * environment variables `G_FILENAME_ENCODING` and `G_BROKEN_FILENAMES`.
+ * On Windows, the character set used in the GLib API is always UTF-8
+ * and said environment variables have no effect.
  *
- * <envar>G_FILENAME_ENCODING</envar> may be set to a comma-separated list 
- * of character set names. The special token "&commat;locale" is taken to 
- * mean the character set for the <link linkend="setlocale">current 
- * locale</link>. If <envar>G_FILENAME_ENCODING</envar> is not set, but 
- * <envar>G_BROKEN_FILENAMES</envar> is, the character set of the current 
- * locale is taken as the filename encoding. If neither environment variable 
+ * `G_FILENAME_ENCODING` may be set to a comma-separated list of
+ * character set names. The special token "&commat;locale" is taken
+ * to  mean the character set for the <link linkend="setlocale">current 
+ * locale</link>. If `G_FILENAME_ENCODING` is not set, but 
+ * `G_BROKEN_FILENAMES` is, the character set of the current locale
+ * is taken as the filename encoding. If neither environment variable 
  * is set, UTF-8 is taken as the filename encoding, but the character
  * set of the current locale is also put in the list of encodings.
  *
  * The returned @charsets belong to GLib and must not be freed.
  *
  * Note that on Unix, regardless of the locale character set or
- * <envar>G_FILENAME_ENCODING</envar> value, the actual file names present 
+ * `G_FILENAME_ENCODING` value, the actual file names present 
  * on a system might be in any random encoding or just gibberish.
  *
  * Return value: %TRUE if the filename encoding is UTF-8.
diff --git a/glib/gfileutils.c b/glib/gfileutils.c
index 99b4bc1..471f0dc 100644
--- a/glib/gfileutils.c
+++ b/glib/gfileutils.c
@@ -72,8 +72,8 @@
  *
  * The pathname argument should be in the GLib file name encoding.
  * On POSIX this is the actual on-disk encoding which might correspond
- * to the locale settings of the process (or the
- * <envar>G_FILENAME_ENCODING</envar> environment variable), or not.
+ * to the locale settings of the process (or the `G_FILENAME_ENCODING`
+ * environment variable), or not.
  *
  * On Windows the GLib file name encoding is UTF-8. Note that the
  * Microsoft C library does not use UTF-8, but has separate APIs for
@@ -309,7 +309,7 @@ g_mkdir_with_parents (const gchar *pathname,
  * %G_FILE_TEST_IS_SYMLINK will always return %FALSE. Testing for
  * %G_FILE_TEST_IS_EXECUTABLE will just check that the file exists and
  * its name indicates that it is executable, checking for well-known
- * extensions and those listed in the <envar>PATHEXT</envar> environment variable.
+ * extensions and those listed in the `PATHEXT` environment variable.
  *
  * Return value: whether a test was %TRUE
  **/
diff --git a/glib/ggettext.c b/glib/ggettext.c
index d4402f9..30f0610 100644
--- a/glib/ggettext.c
+++ b/glib/ggettext.c
@@ -410,7 +410,7 @@ g_dgettext (const gchar *domain,
  * @category: a locale category
  *
  * This is a variant of g_dgettext() that allows specifying a locale
- * category instead of always using <envar>LC_MESSAGES</envar>. See g_dgettext() for
+ * category instead of always using `LC_MESSAGES`. See g_dgettext() for
  * more information about how this functions differs from calling
  * dcgettext() directly.
  *
diff --git a/glib/gkeyfile.c b/glib/gkeyfile.c
index 6ee3c74..71910cb 100644
--- a/glib/gkeyfile.c
+++ b/glib/gkeyfile.c
@@ -118,8 +118,9 @@
  * Key-value pairs generally have the form <literal>key=value</literal>,
  * with the exception of localized strings, which have the form
  * <literal>key[locale]=value</literal>, with a locale identifier of the
- * form <literal>lang_COUNTRY MODIFIER</literal> where
- * <literal>COUNTRY</literal> and <literal>MODIFIER</literal> are optional.
+ * form <literal>lang_COUNTRY\ MODIFIER</literal>
+ * where <literal>COUNTRY</literal> and <literal>MODIFIER</literal>
+ * are optional.
  * Space before and after the '=' character are ignored. Newline, tab,
  * carriage return and backslash characters in value are escaped as \n,
  * \t, \r, and \\, respectively. To preserve leading spaces in values,
diff --git a/glib/glib-init.c b/glib/glib-init.c
index 9ca171f..be573a7 100644
--- a/glib/glib-init.c
+++ b/glib/glib-init.c
@@ -45,7 +45,7 @@ G_STATIC_ASSERT (_g_alignof (GFunc) == _g_alignof (GCompareDataFunc));
 /**
  * g_mem_gc_friendly:
  *
- * This variable is %TRUE if the <envar>G_DEBUG</envar> environment variable
+ * This variable is %TRUE if the `G_DEBUG` environment variable
  * includes the key <literal>gc-friendly</literal>.
  */
 #ifdef ENABLE_GC_FRIENDLY_DEFAULT
diff --git a/glib/gmessages.c b/glib/gmessages.c
index ce01c7a..d1a4176 100644
--- a/glib/gmessages.c
+++ b/glib/gmessages.c
@@ -173,13 +173,13 @@
  *
  * A convenience function/macro to log a warning message.
  *
- * You can make warnings fatal at runtime by setting the
- * <envar>G_DEBUG</envar> environment variable (see
- * <ulink url="glib-running.html">Running GLib Applications</ulink>).
+ * You can make warnings fatal at runtime by setting the `G_DEBUG`
+ * environment variable (see <ulink url="glib-running.html">Running
+ * GLib Applications</ulink>).
  *
- * If g_log_default_handler() is used as the log handler function, a new-line
- * character will automatically be appended to @..., and need not be entered
- * manually.
+ * If g_log_default_handler() is used as the log handler function,
+ * a newline character will automatically be appended to @..., and
+ * need not be entered manually.
  */
 
 /**
@@ -195,7 +195,7 @@
  * example.
  *
  * You can also make critical warnings fatal at runtime by
- * setting the <envar>G_DEBUG</envar> environment variable (see
+ * setting the `G_DEBUG` environment variable (see
  * <ulink url="glib-running.html">Running GLib Applications</ulink>).
  *
  * If g_log_default_handler() is used as the log handler function, a new-line
@@ -449,7 +449,7 @@ g_log_domain_get_handler_L (GLogDomain      *domain,
  * %G_LOG_LEVEL_ERROR is always fatal.
  *
  * You can also make some message levels fatal at runtime by setting
- * the <envar>G_DEBUG</envar> environment variable (see
+ * the `G_DEBUG` environment variable (see
  * <ulink url="glib-running.html">Running GLib Applications</ulink>).
  *
  * Returns: the old fatal mask
@@ -1345,13 +1345,13 @@ escape_string (GString *string)
  * The behavior of this log handler can be influenced by a number of
  * environment variables:
  *
- * - <envar>G_MESSAGES_PREFIXED</envar>: A :-separated list of log levels
- *   for which messages should be prefixed by the program name and PID of
- *   the aplication.
+ * - `G_MESSAGES_PREFIXED`: A :-separated list of log levels for which
+ *   messages should be prefixed by the program name and PID of the
+ *   aplication.
  *
- * - <envar>G_MESSAGES_DEBUG</envar>: A space-separated list of log domains
- *   for which debug and informational messages are printed. By default these
- *   messages are not printed.
+ * - `G_MESSAGES_DEBUG`: A space-separated list of log domains for
+ *   which debug and informational messages are printed. By default
+ *   these messages are not printed.
  *
  * stderr is used for levels %G_LOG_LEVEL_ERROR, %G_LOG_LEVEL_CRITICAL,
  * %G_LOG_LEVEL_WARNING and %G_LOG_LEVEL_MESSAGE. stdout is used for
diff --git a/glib/grand.c b/glib/grand.c
index 1ca4857..0c10124 100644
--- a/glib/grand.c
+++ b/glib/grand.c
@@ -106,10 +106,9 @@
  *
  * The original seeding and generation algorithms, as found in
  * GLib 2.0.x, can be used instead of the new ones by setting the
- * environment variable <envar>G_RANDOM_VERSION</envar> to the value
- * of '2.0'. Use the GLib-2.0 algorithms only if you have sequences
- * of numbers generated with Glib-2.0 that you need to reproduce
- * exactly.
+ * environment variable `G_RANDOM_VERSION` to the value of '2.0'.
+ * Use the GLib-2.0 algorithms only if you have sequences of numbers
+ * generated with Glib-2.0 that you need to reproduce exactly.
  */
 
 /**
diff --git a/glib/gspawn.c b/glib/gspawn.c
index 86aa89c..f5c88a5 100644
--- a/glib/gspawn.c
+++ b/glib/gspawn.c
@@ -470,18 +470,18 @@ g_spawn_sync (const gchar          *working_directory,
  *
  * Executes a child program asynchronously (your program will not
  * block waiting for the child to exit). The child program is
- * specified by the only argument that must be provided, @argv. @argv
- * should be a %NULL-terminated array of strings, to be passed as the
- * argument vector for the child. The first string in @argv is of
- * course the name of the program to execute. By default, the name of
- * the program must be a full path. If @flags contains the 
- * %G_SPAWN_SEARCH_PATH flag, the <envar>PATH</envar> environment variable 
- * is used to search for the executable. If @flags contains the
- * %G_SPAWN_SEARCH_PATH_FROM_ENVP flag, the <envar>PATH</envar> variable from 
- * @envp is used to search for the executable.
- * If both the %G_SPAWN_SEARCH_PATH and %G_SPAWN_SEARCH_PATH_FROM_ENVP
- * flags are set, the <envar>PATH</envar> variable from @envp takes precedence 
- * over the environment variable.
+ * specified by the only argument that must be provided, @argv.
+ * @argv should be a %NULL-terminated array of strings, to be passed
+ * as the argument vector for the child. The first string in @argv
+ * is of course the name of the program to execute. By default, the
+ * name of the program must be a full path. If @flags contains the
+ * %G_SPAWN_SEARCH_PATH flag, the `PATH` environment variable is
+ * used to search for the executable. If @flags contains the
+ * %G_SPAWN_SEARCH_PATH_FROM_ENVP flag, the `PATH` variable from 
+ * @envp is used to search for the executable. If both the
+ * %G_SPAWN_SEARCH_PATH and %G_SPAWN_SEARCH_PATH_FROM_ENVP flags
+ * are set, the `PATH` variable from @envp takes precedence over
+ * the environment variable.
  *
  * If the program name is not a full path and %G_SPAWN_SEARCH_PATH flag is not
  * used, then the program will be run from the current directory (or
@@ -543,15 +543,15 @@ g_spawn_sync (const gchar          *working_directory,
  *
  * %G_SPAWN_LEAVE_DESCRIPTORS_OPEN means that the parent's open file
  * descriptors will be inherited by the child; otherwise all descriptors
- * except stdin/stdout/stderr will be closed before calling exec() in the
- * child. %G_SPAWN_SEARCH_PATH means that @argv[0] need not be an absolute
- * path, it will be looked for in the <envar>PATH</envar> environment
- * variable. %G_SPAWN_SEARCH_PATH_FROM_ENVP means need not be an absolute
- * path, it will be looked for in the <envar>PATH</envar> variable from
+ * except stdin/stdout/stderr will be closed before calling exec() in
+ * the child. %G_SPAWN_SEARCH_PATH means that @argv[0] need not be an
+ * absolute path, it will be looked for in the `PATH` environment
+ * variable. %G_SPAWN_SEARCH_PATH_FROM_ENVP means need not be an
+ * absolute path, it will be looked for in the `PATH` variable from
  * @envp. If both %G_SPAWN_SEARCH_PATH and %G_SPAWN_SEARCH_PATH_FROM_ENVP
  * are used, the value from @envp takes precedence over the environment.
- * %G_SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output will 
- * be discarded, instead of going to the same location as the parent's 
+ * %G_SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output
+ * will be discarded, instead of going to the same location as the parent's 
  * standard output. If you use this flag, @standard_output must be %NULL.
  * %G_SPAWN_STDERR_TO_DEV_NULL means that the child's standard error
  * will be discarded, instead of going to the same location as the parent's
diff --git a/glib/gtestutils.c b/glib/gtestutils.c
index eeb87d6..1e144c0 100644
--- a/glib/gtestutils.c
+++ b/glib/gtestutils.c
@@ -320,7 +320,7 @@
  * an error message is logged and the application is terminated.
  *
  * The macro can be turned off in final releases of code by defining
- * <envar>G_DISABLE_ASSERT</envar> when compiling the application.
+ * `G_DISABLE_ASSERT` when compiling the application.
  */
 
 /**
@@ -331,7 +331,7 @@
  * application is terminated.
  *
  * The macro can be turned off in final releases of code by defining
- * <envar>G_DISABLE_ASSERT</envar> when compiling the application.
+ * `G_DISABLE_ASSERT` when compiling the application.
  */
 
 /**
diff --git a/glib/gtimezone.c b/glib/gtimezone.c
index 1295097..49c4011 100644
--- a/glib/gtimezone.c
+++ b/glib/gtimezone.c
@@ -1304,8 +1304,8 @@ rules_from_identifier (const gchar   *identifier,
  * Creates a #GTimeZone corresponding to @identifier.
  *
  * @identifier can either be an RFC3339/ISO 8601 time offset or
- * something that would pass as a valid value for the
- * <envar>TZ</envar> environment variable (including %NULL).
+ * something that would pass as a valid value for the `TZ` environment
+ * variable (including %NULL).
  *
  * In Windows, @identifier can also be the unlocalized name of a time
  * zone for standard time, for example "Pacific Standard Time".
@@ -1316,13 +1316,13 @@ rules_from_identifier (const gchar   *identifier,
  * time values to be added to Coordinated Universal Time (UTC) to get
  * the local time.
  *
- * In Unix, the <envar>TZ</envar> environment variable typically
- * corresponds to the name of a file in the zoneinfo database, or
- * string in "std offset [dst [offset],start[/time],end[/time]]"
- * (POSIX) format.  There  are  no spaces in the specification.  The
- * name of standard and daylight savings time zone must be three or more
- * alphabetic characters.  Offsets are time values to be added to local
- * time to get Coordinated Universal Time (UTC) and should be
+ * In Unix, the `TZ` environment variable typically corresponds
+ * to the name of a file in the zoneinfo database, or string in
+ * "std offset [dst [offset],start[/time],end[/time]]" (POSIX) format.
+ * There  are  no spaces in the specification. The name of standard
+ * and daylight savings time zone must be three or more alphabetic
+ * characters. Offsets are time values to be added to local time to
+ * get Coordinated Universal Time (UTC) and should be
  * <literal>"[±]hh[[:]mm[:ss]]"</literal>.  Dates are either
  * <literal>"Jn"</literal> (Julian day with n between 1 and 365, leap
  * years not counted), <literal>"n"</literal> (zero-based Julian day
@@ -1339,17 +1339,17 @@ rules_from_identifier (const gchar   *identifier,
  * Coordinated Universal Time (UTC).
  *
  * g_time_zone_new_local() calls this function with the value of the
- * <envar>TZ</envar> environment variable.  This function itself is
- * independent of the value of <envar>TZ</envar>, but if @identifier
- * is %NULL then <filename>/etc/localtime</filename> will be consulted
+ * `TZ` environment variable. This function itself is independent of
+ * the value of `TZ`, but if @identifier is %NULL then
+ * <filename>/etc/localtime</filename> will be consulted
  * to discover the correct time zone on Unix and the registry will be
  * consulted or GetTimeZoneInformation() will be used to get the local
  * time zone on Windows.
  *
- * If intervals are not available, only time zone rules from
- * <envar>TZ</envar> environment variable or other means, then they
- * will be computed from year 1900 to 2037.  If the maximum year for the
- * rules is available and it is greater than 2037, then it will followed
+ * If intervals are not available, only time zone rules from `TZ`
+ * environment variable or other means, then they will be computed
+ * from year 1900 to 2037.  If the maximum year for the rules is
+ * available and it is greater than 2037, then it will followed
  * instead.
  *
  * See <ulink
@@ -1359,7 +1359,7 @@ rules_from_identifier (const gchar   *identifier,
  * full list of valid time offsets.  See <ulink
  * url='http://www.gnu.org/s/libc/manual/html_node/TZ-Variable.html'>The
  * GNU C Library manual</ulink> for an explanation of the possible
- * values of the <envar>TZ</envar> environment variable.  See <ulink
+ * values of the `TZ` environment variable.  See <ulink
  * url='http://msdn.microsoft.com/en-us/library/ms912391%28v=winembedded.11%29.aspx'>
  * Microsoft Time Zone Index Values</ulink> for the list of time zones
  * on Windows.
@@ -1492,9 +1492,8 @@ g_time_zone_new_utc (void)
  * zone may change between invocations to this function; for example,
  * if the system administrator changes it.
  *
- * This is equivalent to calling g_time_zone_new() with the value of the
- * <envar>TZ</envar> environment variable (including the possibility
- * of %NULL).
+ * This is equivalent to calling g_time_zone_new() with the value of
+ * the `TZ` environment variable (including the possibility of %NULL).
  *
  * You should release the return value by calling g_time_zone_unref()
  * when you are done with it.
diff --git a/glib/gutils.c b/glib/gutils.c
index bc206be..a63bf65 100644
--- a/glib/gutils.c
+++ b/glib/gutils.c
@@ -313,15 +313,15 @@ g_find_program_in_path (const gchar *program)
  *  
  * On Windows, if @program does not have a file type suffix, tries
  * with the suffixes .exe, .cmd, .bat and .com, and the suffixes in
- * the <envar>PATHEXT</envar> environment variable. 
+ * the `PATHEXT` environment variable. 
  * 
  * On Windows, it looks for the file in the same way as CreateProcess() 
  * would. This means first in the directory where the executing
  * program was loaded from, then in the current directory, then in the
  * Windows 32-bit system directory, then in the Windows directory, and
- * finally in the directories in the <envar>PATH</envar> environment 
- * variable. If the program is found, the return value contains the 
- * full name including the type suffix.
+ * finally in the directories in the `PATH` environment variable. If
+ * the program is found, the return value contains the full name
+ * including the type suffix.
  *
  * Return value: a newly-allocated string with the absolute path, or %NULL
  **/
@@ -788,26 +788,25 @@ g_get_real_name (void)
  * Gets the current user's home directory.
  *
  * As with most UNIX tools, this function will return the value of the
- * <envar>HOME</envar> environment variable if it is set to an existing
- * absolute path name, falling back to the <filename>passwd</filename>
+ * `HOME` environment variable if it is set to an existing absolute path
+ * name, falling back to the <filename>passwd</filename>
  * file in the case that it is unset.
  *
- * If the path given in <envar>HOME</envar> is non-absolute, does not
- * exist, or is not a directory, the result is undefined.
+ * If the path given in `HOME` is non-absolute, does not exist, or is
+ * not a directory, the result is undefined.
  *
- * Before version 2.36 this function would ignore the
- * <envar>HOME</envar> environment variable, taking the value from the
- * <filename>passwd</filename> database instead.  This was changed to
- * increase the compatibility of GLib with other programs (and the XDG
- * basedir specification) and to increase testability of programs
- * based on GLib (by making it easier to run them from test
- * frameworks).
+ * Before version 2.36 this function would ignore the `HOME` environment
+ * variable, taking the value from the <filename>passwd</filename>
+ * database instead. This was changed to increase the compatibility
+ * of GLib with other programs (and the XDG basedir specification)
+ * and to increase testability of programs based on GLib (by making
+ * it easier to run them from test frameworks).
  *
  * If your program has a strong requirement for either the new or the
  * old behaviour (and if you don't wish to increase your GLib
  * dependency to ensure that the new behaviour is in effect) then you
- * should either directly check the <envar>HOME</envar> environment
- * variable yourself or unset it before calling any functions in GLib.
+ * should either directly check the `HOME` environment variable yourself
+ * or unset it before calling any functions in GLib.
  *
  * Returns: the current user's home directory
  */
@@ -892,17 +891,18 @@ g_get_home_dir (void)
  *
  * Gets the directory to use for temporary files.
  *
- * On UNIX, this is taken from the <envar>TMPDIR</envar> environment
- * variable.  If the variable is not set, <literal>P_tmpdir</literal> is
- * used, as defined by the system C library.  Failing that, a hard-coded
- * default of "/tmp" is returned.
+ * On UNIX, this is taken from the `TMPDIR` environment variable.
+ * If the variable is not set, <literal>P_tmpdir</literal> is
+ * used, as defined by the system C library. Failing that, a
+ * hard-coded default of "/tmp" is returned.
  *
- * On Windows, the <envar>TEMP</envar> environment variable is used,
- * with the root directory of the Windows installation (eg: "C:\") used
+ * On Windows, the `TEMP` environment variable is used, with the
+ * root directory of the Windows installation (eg: "C:\") used
  * as a default.
  *
- * The encoding of the returned string is system-defined. On Windows, it
- * is always UTF-8. The return value is never %NULL or the empty string.
+ * The encoding of the returned string is system-defined. On Windows,
+ * it is always UTF-8. The return value is never %NULL or the empty
+ * string.
  *
  * Returns: the directory to use for temporary files.
  */
@@ -1313,7 +1313,7 @@ g_get_user_cache_dir (void)
  * On UNIX platforms this is determined using the mechanisms described in
  * the <ulink url="http://www.freedesktop.org/Standards/basedir-spec";>
  * XDG Base Directory Specification</ulink>.  This is the directory
- * specified in the <envar>XDG_RUNTIME_DIR</envar> environment variable.
+ * specified in the `XDG_RUNTIME_DIR` environment variable.
  * In the case that this variable is not set, GLib will issue a warning
  * message to stderr and return the value of g_get_user_cache_dir().
  *
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]