summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAdrian Szyndela <adrian.s@samsung.com>2020-01-22 13:42:50 +0100
committerAdrian Szyndela <adrian.s@samsung.com>2020-01-31 11:47:22 +0100
commit334e3983aa0e34e230a2b2e570fba224895f834c (patch)
tree2fd7c7da9d03feb2efdeb581c56a1d887f805fb5 /docs
parent16de6133fd8d9aec9b220ce384b119d8aff95f0f (diff)
parent8642074d1c7da579f439a1004fc1240d3db5f19b (diff)
downloadglib-334e3983aa0e34e230a2b2e570fba224895f834c.tar.gz
glib-334e3983aa0e34e230a2b2e570fba224895f834c.tar.bz2
glib-334e3983aa0e34e230a2b2e570fba224895f834c.zip
Merge 2.60.0 into tizen
Change-Id: I8a4df520c88d40ff8151040aeace30f6035f2673
Diffstat (limited to 'docs')
-rw-r--r--docs/CODE-OWNERS2
-rw-r--r--docs/CODEOWNERS80
-rw-r--r--docs/reference/gobject/glib-mkenums.xml62
-rw-r--r--docs/reference/gobject/meson.build2
4 files changed, 113 insertions, 33 deletions
diff --git a/docs/CODE-OWNERS b/docs/CODE-OWNERS
deleted file mode 100644
index 03943cbb8..000000000
--- a/docs/CODE-OWNERS
+++ /dev/null
@@ -1,2 +0,0 @@
-Currently, all code is maintained equally by the core maintainers.
-See glib.doap for their names. \ No newline at end of file
diff --git a/docs/CODEOWNERS b/docs/CODEOWNERS
new file mode 100644
index 000000000..187660422
--- /dev/null
+++ b/docs/CODEOWNERS
@@ -0,0 +1,80 @@
+# These are the people responsible for subsystems in GLib; if you're opening
+# a merge request for files listed here, please add the following people to
+# the list of reviewers
+
+# The syntax of this file is defined by GitLab:
+# https://docs.gitlab.com/ee/user/project/code_owners.html
+# Which, in turn, is similar to the .gitignore and .gitattributes files:
+#
+# - comments start with `#`
+# - the first column contains paths and globs
+# - the second column contains GitLab user names or email addresses,
+# separated by spaces
+#
+# The last matching glob (rather than the union of *all* matching globs) gives
+# the owners of a piece of code.
+#
+# If you want to be responsible for code reviews in specific sections of
+# the GLib code base, add yourself here.
+
+# Overall maintainers
+* @pwithnall @ebassi
+
+# Build system
+meson.build @xclaesse @nirbheek @pwithnall
+meson_options.txt @xclaesse @nirbheek @pwithnall
+subprojects/ @xclaesse @nirbheek @pwithnall
+
+# CI integration
+.gitlab-ci* @pwithnall @xclaesse @creiter
+
+# macOS support
+*osx* @jralls @pwithnall @sdroege
+*.m @jralls @pwithnall @sdroege
+
+# Windows support
+*win32* @lrn @creiter @fanc999 @pwithnall @sdroege
+
+# Windows support (MSVC specific)
+*msvc* @fanc999 @creiter @pwithnall @sdroege
+
+# Android support
+*android* @xclaesse @pwithnall @sdroege
+
+# BSD support
+*bsd* @jmatthew @ajacoutot @lantw @pwithnall
+*kqueue* @jmatthew @ajacoutot @lantw @pwithnall
+
+# flatpak portals
+gio/*portal* @matthiasc @alexl @pwithnall
+
+# Networking
+gio/g*{tcp,udp,tls,socket,resolver,proxy,network,inet,datagram}* @mcatanzaro @pgriffis @pwithnall @sdroege
+
+# D-Bus
+gio/g*bus* @smcv @pwithnall
+
+# I/O
+gio/g*{file,vfs,mount,drive,volume}* @oholy @alexl @pwithnall @sdroege
+gio/g*stream* @alexl @pwithnall @sdroege
+gio/gio-tool* @oholy @alexl @pwithnall
+
+# Generic bits of GLib
+glib/ @ebassi @pwithnall @sdroege
+
+# GObject type system
+gobject/ @ebassi @pwithnall @sdroege
+
+# GVariant
+glib/gvariant* @pwithnall @sdroege
+
+# grefcount, GRcBox and GRefString
+glib/gref{count,string}.[ch] @ebassi @pwithnall @sdroege
+glib/grc*.[ch] @ebassi @pwithnall @sdroege
+glib/garc*.[ch] @ebassi @pwithnall @sdroege
+
+# Logging
+glib/gmessages.[ch] @pwithnall @sdroege
+
+# Google clusterfuzz support
+fuzzing/ @pwithnall \ No newline at end of file
diff --git a/docs/reference/gobject/glib-mkenums.xml b/docs/reference/gobject/glib-mkenums.xml
index 84023e9b1..4c8641657 100644
--- a/docs/reference/gobject/glib-mkenums.xml
+++ b/docs/reference/gobject/glib-mkenums.xml
@@ -35,20 +35,21 @@
<para><command>glib-mkenums</command> is a small utility that parses C code to
extract enum definitions and produces enum descriptions based on text templates
specified by the user. Typically, you can use this tool to generate enumeration
-types for the GType type system, for #GObject properties and signal marshalling;
-additionally, you can use it to generate enumeration values of #GSettings schemas.
+types for the GType type system, for GObject properties and signal marshalling;
+additionally, you can use it to generate enumeration values of GSettings schemas.
</para>
<para><command>glib-mkenums</command> takes a list of valid C code files as
input. The options specified control the text that generated, substituting various
-keywords enclosed in @ characters in the templates.
+keywords enclosed in <literal>@</literal> characters in the templates.
</para>
<refsect2><title>Production text substitutions</title>
<para>
-Certain keywords enclosed in @ characters will be substituted in the
+Certain keywords enclosed in <literal>@</literal> characters will be substituted in the
emitted text. For the substitution examples of the keywords below,
the following example enum definition is assumed:
+</para>
<informalexample><programlisting>
typedef enum
{
@@ -58,7 +59,7 @@ typedef enum
</programlisting></informalexample>
<variablelist>
<varlistentry>
-<term>@EnumName@</term>
+<term><literal>@EnumName@</literal>></term>
<listitem><para>
The name of the enum currently being processed, enum names are assumed to be
properly namespaced and to use mixed capitalization to separate
@@ -67,7 +68,7 @@ words (e.g. <literal>PrefixTheXEnum</literal>).
</varlistentry>
<varlistentry>
-<term>@enum_name@</term>
+<term><literal>@enum_name@</literal></term>
<listitem><para>
The enum name with words lowercase and word-separated by underscores
(e.g. <literal>prefix_the_xenum</literal>).
@@ -75,7 +76,7 @@ The enum name with words lowercase and word-separated by underscores
</varlistentry>
<varlistentry>
-<term>@ENUMNAME@</term>
+<term><literal>@ENUMNAME@</literal></term>
<listitem><para>
The enum name with words uppercase and word-separated by underscores
(e.g. <literal>PREFIX_THE_XENUM</literal>).
@@ -83,7 +84,7 @@ The enum name with words uppercase and word-separated by underscores
</varlistentry>
<varlistentry>
-<term>@ENUMSHORT@</term>
+<term><literal>@ENUMSHORT@</literal></term>
<listitem><para>
The enum name with words uppercase and word-separated by underscores,
prefix stripped (e.g. <literal>THE_XENUM</literal>).
@@ -91,14 +92,14 @@ prefix stripped (e.g. <literal>THE_XENUM</literal>).
</varlistentry>
<varlistentry>
-<term>@ENUMPREFIX@</term>
+<term><literal>@ENUMPREFIX@</literal></term>
<listitem><para>
The prefix of the enum name (e.g. <literal>PREFIX</literal>).
</para></listitem>
</varlistentry>
<varlistentry>
-<term>@VALUENAME@</term>
+<term><literal>@VALUENAME@</literal></term>
<listitem><para>
The enum value name currently being processed with words uppercase and
word-separated by underscores,
@@ -108,7 +109,7 @@ this is the assumed literal notation of enum values in the C sources
</varlistentry>
<varlistentry>
-<term>@valuenick@</term>
+<term><literal>@valuenick@</literal></term>
<listitem><para>
A nick name for the enum value currently being processed, this is usually
generated by stripping common prefix words of all the enum values of the
@@ -118,7 +119,7 @@ minus (e.g. <literal>the-xvalue</literal>).
</varlistentry>
<varlistentry>
-<term>@valuenum@</term>
+<term><literal>@valuenum@</literal></term>
<listitem><para>
The integer value for the enum value currently being processed. If the
evaluation fails then <command>glib-mkenums</command> will exit with an
@@ -128,61 +129,61 @@ appears in your value production template. (Since: 2.26)
</varlistentry>
<varlistentry>
-<term>@type@</term>
+<term><literal>@type@</literal></term>
<listitem><para>
This is substituted either by "enum" or "flags", depending on whether the
-enum value definitions contained bit-shift operators or not (e.g. flags).
+enum value definitions contained bit-shift operators or not (e.g. <literal>flags</literal>).
</para></listitem>
</varlistentry>
<varlistentry>
-<term>@Type@</term>
+<term><literal>@Type@</literal></term>
<listitem><para>
-The same as <literal>@type@</literal> with the first letter capitalized (e.g. Flags).
+The same as <literal>@type@</literal> with the first letter capitalized (e.g. <literal>Flags</literal>).
</para></listitem>
</varlistentry>
<varlistentry>
-<term>@TYPE@</term>
+<term><literal>@TYPE@</literal></term>
<listitem><para>
-The same as <literal>@type@</literal> with all letters uppercased (e.g. FLAGS).
+The same as <literal>@type@</literal> with all letters uppercased (e.g. <literal>FLAGS</literal>).
</para></listitem>
</varlistentry>
<varlistentry>
-<term>@filename@</term>
+<term><literal>@filename@</literal></term>
<listitem><para>
-The name of the input file currently being processed (e.g. foo.h).
+The name of the input file currently being processed (e.g. <literal>foo.h</literal>).
</para></listitem>
</varlistentry>
<varlistentry>
-<term>@basename@</term>
+<term><literal>@basename@</literal></term>
<listitem><para>
-The base name of the input file currently being processed (e.g. foo.h). Typically
+The base name of the input file currently being processed (e.g. <literal>foo.h</literal>). Typically
you want to use <literal>@basename@</literal> in place of <literal>@filename@</literal> in your templates, to improve the reproducibility of the build. (Since: 2.22)
</para></listitem>
</varlistentry>
</variablelist>
-</para>
</refsect2>
<refsect2><title>Trigraph extensions</title>
<para>
Some C comments are treated specially in the parsed enum definitions,
such comments start out with the trigraph sequence <literal>/*&lt;</literal>
and end with the trigraph sequence <literal>&gt;*/</literal>.
-Per enum definition, the options "skip" and "flags" can be specified, to
+Per enum definition, the options <literal>skip</literal> and <literal>flags</literal> can be specified, to
indicate this enum definition to be skipped, or for it to be treated as
a flags definition, or to specify the common prefix to be stripped from
-all values to generate value nicknames, respectively. The "underscore_name"
-option can be used to specify the word separation used in the *_get_type()
+all values to generate value nicknames, respectively. The <literal>underscore_name</literal>
+option can be used to specify the word separation used in the <function>*_get_type()</function>
function. For instance, <literal>/*&lt; underscore_name=gnome_vfs_uri_hide_options &gt;*/</literal>.
</para>
<para>
-Per value definition, the options "skip" and "nick" are supported.
+Per value definition, the options <literal>skip</literal> and <literal>nick</literal> are supported.
The former causes the value to be skipped, and the latter can be used to
specify the otherwise auto-generated nickname.
Examples:
+</para>
<informalexample><programlisting>
typedef enum /*&lt; skip &gt;*/
{
@@ -196,7 +197,6 @@ typedef enum /*&lt; flags,prefix=PREFIX &gt;*/
PREFIX_THE_THIRD_VALUE, /*&lt; nick=the-last-value &gt;*/
} PrefixTheFlagsEnum;
</programlisting></informalexample>
-</para>
</refsect2>
</refsect1>
@@ -317,12 +317,14 @@ Template for auto-generated comments, the default (for C code generations) is
<term><option>--template</option> <replaceable>FILE</replaceable></term>
<listitem><para>
Read templates from the given file. The templates are enclosed in
-specially-formatted C comments
+specially-formatted C comments:
+</para>
<informalexample><programlisting>
/*** BEGIN section ***/
/*** END section ***/
</programlisting></informalexample>
-where section may be <literal>file-header</literal>,
+<para>
+<replaceable>section</replaceable> may be <literal>file-header</literal>,
<literal>file-production</literal>, <literal>file-tail</literal>,
<literal>enumeration-production</literal>, <literal>value-header</literal>,
<literal>value-production</literal>, <literal>value-tail</literal> or
diff --git a/docs/reference/gobject/meson.build b/docs/reference/gobject/meson.build
index e955e9907..175520b64 100644
--- a/docs/reference/gobject/meson.build
+++ b/docs/reference/gobject/meson.build
@@ -7,7 +7,7 @@ if get_option('gtk_doc')
'gobject_probes.h',
'gobject_trace.h',
'gtype-private.h',
- 'gobjectenumtypes.h'
+ 'glib-enumtypes.h',
]
ignore_decorators = [