docs: Move the ghostutils SECTION

Sadly, this is about hostnames rather than ghosts. 😞

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

Helps: #3037
This commit is contained in:
Philip Withnall 2023-11-22 16:50:44 +00:00
parent 425731f766
commit 25a4205d9d
4 changed files with 32 additions and 18 deletions

View File

@ -61,6 +61,7 @@ content_files = [
"error-reporting.md",
"logging.md",
"file-utils.md",
"host-utils.md",
"main-loop.md",
"reference-counting.md",
"testing.md",

View File

@ -0,0 +1,30 @@
Title: Hostname Utilities
SPDX-License-Identifier: LGPL-2.1-or-later
SPDX-FileCopyrightText: 2008 Dan Winship
# Hostname Utilities
Functions for manipulating internet hostnames; in particular, for
converting between Unicode and ASCII-encoded forms of
Internationalized Domain Names (IDNs).
The
[Internationalized Domain Names for Applications (IDNA)](http://www.ietf.org/rfc/rfc3490.txt)
standards allow for the use
of Unicode domain names in applications, while providing
backward-compatibility with the old ASCII-only DNS, by defining an
ASCII-Compatible Encoding of any given Unicode name, which can be
used with non-IDN-aware applications and protocols. (For example,
“Παν語.org” maps to “xn--4wa8awb4637h.org”.)
## Hostname Conversions
* [func@GLib.hostname_to_ascii]
* [func@GLib.hostname_to_unicode]
## Hostname Checks
* [func@GLib.hostname_is_non_ascii]
* [func@GLib.hostname_is_ascii_encoded]
* [func@GLib.hostname_is_ip_address]

View File

@ -167,6 +167,7 @@ expand_content_files = [
'threads-deprecated.md',
'markup.md',
'goption.md',
'host-utils.md',
'data-structures.md',
'shell.md',
'string-utils.md',

View File

@ -41,24 +41,6 @@
#endif
/**
* SECTION:ghostutils
* @short_description: Internet hostname utilities
*
* Functions for manipulating internet hostnames; in particular, for
* converting between Unicode and ASCII-encoded forms of
* Internationalized Domain Names (IDNs).
*
* The
* [Internationalized Domain Names for Applications (IDNA)](http://www.ietf.org/rfc/rfc3490.txt)
* standards allow for the use
* of Unicode domain names in applications, while providing
* backward-compatibility with the old ASCII-only DNS, by defining an
* ASCII-Compatible Encoding of any given Unicode name, which can be
* used with non-IDN-aware applications and protocols. (For example,
* "Παν語.org" maps to "xn--4wa8awb4637h.org".)
**/
#define IDNA_ACE_PREFIX "xn--"
#define IDNA_ACE_PREFIX_LEN 4