Skip to content
This repository has been archived by the owner on Nov 17, 2020. It is now read-only.

Commit

Permalink
documented G_SLICE=always-malloc and G_DEBUG=gc-friendly. added anchors
Browse files Browse the repository at this point in the history
Wed Jan 25 17:12:47 2006  Tim Janik  <timj@gtk.org>

        * glib/running.sgml: documented G_SLICE=always-malloc and
        G_DEBUG=gc-friendly. added anchors for each env var.
  • Loading branch information
tim-janik authored and Tim Janik committed Jan 25, 2006
1 parent eda944b commit 04f12a2
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 12 deletions.
5 changes: 5 additions & 0 deletions docs/reference/ChangeLog
@@ -1,3 +1,8 @@
Wed Jan 25 17:12:47 2006 Tim Janik <timj@gtk.org>

* glib/running.sgml: documented G_SLICE=always-malloc and
G_DEBUG=gc-friendly. added anchors for each env var.

2006-01-18 Matthias Clasen <mclasen@redhat.com>

* === Released 2.9.4 ===
Expand Down
49 changes: 43 additions & 6 deletions docs/reference/glib/running.sgml
Expand Up @@ -44,7 +44,7 @@ variables like <envar>LANG</envar>, <envar>PATH</envar> or <envar>HOME</envar>.
</para>
</formalpara>

<formalpara>
<formalpara id="G_MESSAGES_PREFIXED">
<title><envar>G_MESSAGES_PREFIXED</envar></title>

<para>
Expand All @@ -54,9 +54,8 @@ variables like <envar>LANG</envar>, <envar>PATH</envar> or <envar>HOME</envar>.
</para>
</formalpara>

<formalpara>
<formalpara id="G_DEBUG">
<title><envar>G_DEBUG</envar></title>

<para>
If GLib has been configured with <option>--enable-debug=yes</option>,
this variable can be set to a list of debug options, which cause GLib
Expand All @@ -79,11 +78,49 @@ variables like <envar>LANG</envar>, <envar>PATH</envar> or <envar>HOME</envar>.
debugging support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>gc-friendly</term>
<listitem>
<para>
Newly allocated memory that isn't directly initialized, as well
as memory being freed will be reset to 0. The point here is to
allow memory checkers and similar programs that use bohem GC alike
algorithms to produce more accurate results.
This option is special in that it doesn't require GLib to be
configured with debugging support.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</formalpara>

<formalpara>
<formalpara id="G_SLICE">
<title><envar>G_SLICE</envar></title>
<para>
This environment variable allows reconfiguration of the #GSlice
memory allocator.
<variablelist>
<varlistentry>
<term>always-malloc</term>
<listitem>
<para>
This will cause all slices allocated through g_slice_alloc() and
released by g_slice_free1() to be actually allocated via direct
calls to g_malloc() and g_free().
This is most useful for memory checkers and similar programs that
use bohem GC alike algorithms to produce more accurate results.
It can also be in conjunction with debugging features of the system's
malloc implementation such as glibc's MALLOC_CHECK_=2 to debug
erroneous slice allocation code.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</formalpara>

<formalpara id="G_RANDOM_VERSION">
<title><envar>G_RANDOM_VERSION</envar></title>

<para>
Expand All @@ -95,7 +132,7 @@ variables like <envar>LANG</envar>, <envar>PATH</envar> or <envar>HOME</envar>.
</para>
</formalpara>

<formalpara>
<formalpara id="LIBCHARSET_ALIAS_DIR">
<title><envar>LIBCHARSET_ALIAS_DIR</envar></title>

<para>
Expand All @@ -106,7 +143,7 @@ variables like <envar>LANG</envar>, <envar>PATH</envar> or <envar>HOME</envar>.
</para>
</formalpara>

<formalpara>
<formalpara id="G_WIN32_PRETEND_WIN9X">
<title><envar>G_WIN32_PRETEND_WIN9X</envar></title>

<para>
Expand Down
27 changes: 21 additions & 6 deletions docs/reference/glib/tmpl/messages.sgml
Expand Up @@ -115,9 +115,12 @@ A convenience function/macro to log a normal message.
</para>

@...: format string, followed by parameters to insert into the format string (as with printf())
<!-- # Unused Parameters # -->
@...:
@...:
@...:

@...:

@...:


Expand All @@ -127,9 +130,12 @@ A convenience function/macro to log a warning message.
</para>

@...: format string, followed by parameters to insert into the format string (as with printf())
<!-- # Unused Parameters # -->
@...:
@...:
@...:

@...:

@...:


Expand All @@ -143,9 +149,12 @@ example.
</para>

@...: format string, followed by parameters to insert into the format string (as with printf())
<!-- # Unused Parameters # -->
@...:
@...:
@...:

@...:

@...:


Expand All @@ -160,9 +169,12 @@ assertion failure.
</para>

@...: the parameters to insert into the format string.
<!-- # Unused Parameters # -->
@...:
@...:
@...:

@...:

@...:


Expand All @@ -172,11 +184,14 @@ A convenience function/macro to log a debug message.
</para>

@...: format string, followed by parameters to insert into the format string (as with printf())
@Since: 2.6
<!-- # Unused Parameters # -->

@...:

@...:
@Since: 2.6
@...:
@...:
@...:


<!-- ##### FUNCTION g_log_set_handler ##### -->
Expand Down

0 comments on commit 04f12a2

Please sign in to comment.