docs: Move the unix SECTION

Move it to a separate page.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-11-23 12:46:18 +00:00
parent 244721baf9
commit 790131687c
4 changed files with 50 additions and 15 deletions

View File

@ -70,6 +70,7 @@ content_files = [
"atomic.md",
"threads.md",
"spawn.md",
"unix.md",
"random.md",
"markup.md",
"base64.md",

View File

@ -175,6 +175,7 @@ expand_content_files = [
'spawn.md',
'string-utils.md',
'unicode.md',
'unix.md',
'uuid.md',
'version.md',
]

View File

@ -0,0 +1,48 @@
Title: Unix-specific Utilities
SPDX-License-Identifier: LGPL-2.1-or-later
SPDX-FileCopyrightText: 2011 Colin Walters
# Unix-specific Utilities
Most of GLib is intended to be portable; in contrast, this set of
functions is designed for programs which explicitly target Unix,
or are using it to build higher level abstractions which would be
conditionally compiled if the platform matches `G_OS_UNIX`.
To use these functions, you must explicitly include the
`glib-unix.h` header.
## File Descriptors
* [func@GLib.unix_open_pipe]
* [func@GLib.unix_set_fd_nonblocking]
## Pipes
The [struct@GLib.UnixPipe] structure can be used to conveniently open and
manipulate a Unix pipe.
<!-- FIXME: https://gitlab.gnome.org/GNOME/gi-docgen/-/issues/173 -->
The methods for it are all static inline for efficiency. They are:
* `g_unix_pipe_open()`
* `g_unix_pipe_get()`
* `g_unix_pipe_steal()`
* `g_unix_pipe_close()`
* `g_unix_pipe_clear()`
## Signals
* [func@GLib.unix_signal_add]
* [func@GLib.unix_signal_add_full]
* [func@GLib.unix_signal_source_new]
## Polling
* [func@GLib.unix_fd_add]
* [func@GLib.unix_fd_add_full]
* [func@GLib.unix_fd_source_new]
## User Database
* [func@GLib.unix_get_passwd_entry]

View File

@ -44,21 +44,6 @@ G_STATIC_ASSERT (G_ALIGNOF (GPid) == G_ALIGNOF (pid_t));
* might not be true everywhere. */
G_STATIC_ASSERT (O_NONBLOCK != FD_CLOEXEC);
/**
* SECTION:gunix
* @title: UNIX-specific utilities and integration
* @short_description: pipes, signal handling
* @include: glib-unix.h
*
* Most of GLib is intended to be portable; in contrast, this set of
* functions is designed for programs which explicitly target UNIX,
* or are using it to build higher level abstractions which would be
* conditionally compiled if the platform matches %G_OS_UNIX.
*
* To use these functions, you must explicitly include the
* "glib-unix.h" header.
*/
G_DEFINE_QUARK (g-unix-error-quark, g_unix_error)
static gboolean