luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-21 16:38:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

More consistent doc formatting

Browse Source 
Move some things around, make capitalization of short descriptions
more consistent.
This commit is contained in:
Matthias Clasen
2011-11-12 21:54:42 -05:00
parent 599f254066
commit 06bb6c75a2
14 changed files with 148 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/glib/glib-docs.sgml
View File

@@ -35,7 +35,6 @@ synchronize their operation.
<xi:include href="compiling.sgml" />
<xi:include href="running.sgml" />
<xi:include href="changes.sgml" />
<xi:include href="regex-syntax.sgml" />
<xi:include href="resources.sgml" />
</chapter>
@@ -92,6 +91,7 @@ synchronize their operation.
<xi:include href="xml/option.xml" />
<xi:include href="xml/patterns.xml" />
<xi:include href="xml/gregex.xml" />
<xi:include href="regex-syntax.sgml" />
<xi:include href="xml/markup.xml" />
<xi:include href="xml/keyfile.xml" />
<xi:include href="xml/bookmarkfile.xml" />

4
docs/reference/glib/gvariant-text.xml
View File

@@ -4,6 +4,10 @@
<refmeta>
<refentrytitle>GVariant Text Format</refentrytitle>
</refmeta>
<refnamediv>
<refname>GVariant Text Format</refname>
<refpurpose>textual representation of GVariants</refpurpose>
</refnamediv>
<refsect1>
<title>GVariant Text Format</title>

7
docs/reference/glib/gvariant-varargs.xml
View File

@@ -4,12 +4,17 @@
<refmeta>
<refentrytitle>GVariant Format Strings</refentrytitle>
</refmeta>
<refnamediv>
<refname>GVariant Format Strings</refname>
<refpurpose>varargs conversion of GVariants</refpurpose>
</refnamediv>
<refsect1>
<title>Variable Argument Conversions</title>
<para>
This page attempts to document how to perform variable argument conversions with GVariant.
This page attempts to document how to perform variable argument
conversions with GVariant.
</para>
<para>
Conversions occur according to format strings. A format string is a two-way mapping between a single

3
docs/reference/glib/regex-syntax.sgml
View File

@@ -7,6 +7,7 @@
<refentrytitle>Regular expression syntax</refentrytitle>
</refmeta>
<!--
Based on the man page for pcrepattern.
@@ -19,7 +20,7 @@ In sync with PCRE 7.0
<refnamediv>
<refname>Regular expression syntax</refname>
<refpurpose>
Syntax and semantics of the regular expressions supported by GRegex
syntax and semantics of regular expressions supported by GRegex
</refpurpose>
</refnamediv>

143
docs/reference/glib/running.sgml
View File

@@ -2,7 +2,7 @@
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
]>
<refentry id="glib-running" revision="17 Jan 2002">
<refentry id="glib-running">
<refmeta>
<refentrytitle>Running GLib Applications</refentrytitle>
<manvolnum>3</manvolnum>
@@ -23,10 +23,32 @@ How to run and debug your GLib application
<title>Environment variables</title>
<para>
GLib inspects a few of environment variables in addition to standard
variables like <envar>LANG</envar>, <envar>PATH</envar> or <envar>HOME</envar>.
The runtime behaviour of GLib applications can be influenced by a
number of environment variables.
</para>
<formalpara>
<title>Standard variables</title>
<para>
GLib reads standard environment variables like <envar>LANG</envar>,
<envar>PATH</envar>, <envar>HOME</envar>, <envar>TMPDIR</envar>,
<envar>TZ</envar> and <envar>LOGNAME</envar>.
</para>
</formalpara>
<formalpara>
<title>XDG directories</title>
<para>
GLib consults the environment variables <envar>XDG_DATA_HOME</envar>,
<envar>XDG_DATA_DIRS</envar>, <envar>XDG_CONFIG_HOME</envar>,
<envar>XDG_CONFIG_DIRS</envar>, <envar>XDG_CACHE_HOME</envar> and
<envar>XDG_RUNTIME_DIR</envar> for the various XDG directories.
For more information, see the <ulink url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG basedir spec</ulink>.
</para>
</formalpara>
<formalpara id="G_FILENAME_ENCODING">
<title><envar>G_FILENAME_ENCODING</envar></title>
@@ -68,7 +90,7 @@ variables like <envar>LANG</envar>, <envar>PATH</envar> or <envar>HOME</envar>.
<literal>help</literal>.
</para>
<para>
This environment variable only affects the GLib log handler,
This environment variable only affects the default log handler,
g_log_default_handler().
</para>
</formalpara>
@@ -85,70 +107,50 @@ variables like <envar>LANG</envar>, <envar>PATH</envar> or <envar>HOME</envar>.
You can also use the special value <literal>all</literal>.
</para>
<para>
This environment variable only affects the GLib log handler,
This environment variable only affects the default log handler,
g_log_default_handler().
</para>
</formalpara>
<formalpara id="G-DEBUG:CAPS">
<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
to print out different types of debugging information.
This environment variable can be set to a list of debug options,
which cause GLib to print out different types of debugging information.
<variablelist>
<varlistentry>
<term>fatal_warnings</term>
<term>fatal-warnings</term>
<listitem><para>Causes GLib to abort the program at the first call
to <link linkend="g-warning">g_warning</link>() or
<link linkend="g-critical">g_critical</link>(). This option is
special in that it doesn't require GLib to be configured with
debugging support.</para>
to g_warning() or g_critical().</para>
</listitem>
</varlistentry>
<varlistentry>
<term>fatal_criticals</term>
<term>fatal-criticals</term>
<listitem><para>Causes GLib to abort the program at the first call
to <link linkend="g-critical">g_critical</link>(). This option is
special in that it doesn't require GLib to be configured with
debugging support.</para>
to g_critical().</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><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 Boehm GC alike
algorithms to produce more accurate results.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>resident-modules</term>
<listitem>
<para>
All modules loaded by GModule will be made resident. This can be useful
for tracking memory leaks in modules which are later unloaded; but it can
also hide bugs where code is accessed after the module would have normally
been unloaded.
This option is special in that it doesn't require GLib to be
configured with debugging support.
</para>
<listitem><para>All modules loaded by GModule will be made resident.
This can be useful for tracking memory leaks in modules which are
later unloaded; but it can also hide bugs where code is accessed
after the module would have normally been unloaded.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>bind-now-modules</term>
<listitem>
<para>
All modules loaded by GModule will bind their symbols at load time, even
when the code uses %G_MODULE_BIND_LAZY.
This option is special in that it doesn't require GLib to be
configured with debugging support.
</para>
<listitem><para>All modules loaded by GModule will bind their symbols
at load time, even when the code uses %G_MODULE_BIND_LAZY.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -159,50 +161,47 @@ variables like <envar>LANG</envar>, <envar>PATH</envar> or <envar>HOME</envar>.
<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().
<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.
use Boehm 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, allthough <literal>debug-blocks</literal>
usually is a better suited debugging tool.
</para>
malloc() implementation such as glibc's MALLOC_CHECK_=2 to debug
erroneous slice allocation code, although
<literal>debug-blocks</literal> is usually a better suited debugging
tool.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>debug-blocks</term>
<listitem>
<para>
Using this option (present since GLib-2.13) engages extra code
which performs sanity checks on the released memory slices.
Invalid slice adresses or slice sizes will be reported and lead to
a program halt.
This option is for debugging scenarios.
<listitem><para>Using this option (present since GLib 2.13) engages
extra code which performs sanity checks on the released memory
slices. Invalid slice adresses or slice sizes will be reported and
lead to a program halt. This option is for debugging scenarios.
In particular, client packages sporting their own test suite should
<emphasis>always enable this option when running tests</emphasis>.
Global slice validation is ensured by storing size and address information
for each allocated chunk, and maintaining a global hash table of that data.
That way, multi-thread scalability is given up, and memory consumption is
increased. However, the resulting code usually performs acceptably well,
possibly better than with comparable memory checking carried out using
external tools. An example of a memory corruption scenario that cannot be
reproduced with <literal>G_SLICE=always-malloc</literal>, but will be caught
by <literal>G_SLICE=debug-blocks</literal> is as follows:
Global slice validation is ensured by storing size and address
information for each allocated chunk, and maintaining a global
hash table of that data. That way, multi-thread scalability is
given up, and memory consumption is increased. However, the
resulting code usually performs acceptably well, possibly better
than with comparable memory checking carried out using external
tools.</para>
<para>An example of a memory corruption scenario that cannot be
reproduced with <literal>G_SLICE=always-malloc</literal>, but will
be caught by <literal>G_SLICE=debug-blocks</literal> is as follows:
<programlisting>
void *slist = g_slist_alloc (); /* void* gives up type-safety */
g_list_free (slist); /* corruption: sizeof (GSList) != sizeof (GList) */
</programlisting>
</para>
</programlisting></para>
</listitem>
</varlistentry>
</variablelist>
@@ -217,9 +216,9 @@ variables like <envar>LANG</envar>, <envar>PATH</envar> or <envar>HOME</envar>.
<para>
If this environment variable is set to '2.0', the outdated
pseudo-random number seeding and generation algorithms from
GLib-2.0 are used instead of the new better ones. Use the GLib-2.0
algorithms only if you have sequences of numbers generated with
Glib-2.0 that you need to reproduce exactly.
GLib 2.0 are used instead of the newer, better ones. You should
only set this variable if you have sequences of numbers that were
generated with Glib 2.0 that you need to reproduce exactly.
</para>
</formalpara>

2
glib/gchecksum.c
View File

@@ -35,7 +35,7 @@
/**
* SECTION:checksum
* @title: Data Checksums
* @short_description: Computes the checksum for data
* @short_description: computes the checksum for data
*
* GLib provides a generic API for computing checksums (or "digests")
* for a sequence of arbitrary bytes, using various hashing algorithms

2
glib/gconvert.c
View File

@@ -69,7 +69,7 @@
/**
* SECTION:conversions
* @title: Character Set Conversion
* @short_description: Convert strings between different character sets
* @short_description: convert strings between different character sets
*
* The g_convert() family of function wraps the functionality of iconv(). In
* addition to pure character set conversions, GLib has functions to deal

2
glib/gdatetime.c
View File

@@ -81,7 +81,7 @@
/**
* SECTION:date-time
* @title: GDateTime
* @short_description: A structure representing Date and Time
* @short_description: a structure representing Date and Time
* @see_also: #GTimeZone
*
* #GDateTime is a structure that combines a Gregorian date and time

2
glib/ghmac.c
View File

@@ -39,7 +39,7 @@
/**
* SECTION:hmac
* @title: Secure HMAC Digests
* @short_description: Computes the HMAC for data
* @short_description: computes the HMAC for data
*
* HMACs should be used when producing a cookie or hash based on data
* and a key. Simple mechanisms for using SHA1 and other algorithms to

4
glib/glist.c
View File

@@ -38,9 +38,7 @@
/**
* SECTION:linked_lists_double
* @title: Doubly-Linked Lists
* @short_description: linked lists containing integer values or
* pointers to data, with the ability to iterate
* over the list in both directions
* @short_description: linked lists that can be iterated over in both directions
*
* The #GList structure and its associated functions provide a standard
* doubly-linked list data structure.

4
glib/gslist.c
View File

@@ -38,9 +38,7 @@
/**
* SECTION:linked_lists_single
* @title: Singly-Linked Lists
* @short_description: linked lists containing integer values or
* pointers to data, limited to iterating over the
* list in one direction
* @short_description: linked lists that can be iterated in one direction
*
* The #GSList structure and its associated functions provide a
* standard singly-linked list data structure.

2
glib/gtimezone.c
View File

@@ -39,7 +39,7 @@
/**
* SECTION:timezone
* @title: GTimeZone
* @short_description: A structure representing a time zone
* @short_description: a structure representing a time zone
* @see_also: #GDateTime
*
* #GTimeZone is a structure that represents a time zone, at no

3
glib/gurifuncs.c
View File

@@ -35,7 +35,8 @@
/**
* SECTION:gurifuncs
* @short_description: URI Functions
* @title: URI Functions
* @short_description: manipulating URIs
*
* Functions for manipulating Universal Resource Identifiers (URIs) as
* defined by <ulink url="http://www.ietf.org/rfc/rfc3986.txt">

2
glib/gversion.c
View File

@@ -31,7 +31,7 @@
/**
* SECTION:version
* @Title: Version Information
* @Short_description: Variables and functions to check the GLib version
* @Short_description: variables and functions to check the GLib version
*
* GLib provides version information, primarily useful in configure
* checks for builds that have a configure script. Applications will