Merge branch '1760-txt-record-docs' into 'master'

docs: Clarify support for multiple TXT record strings

Closes #1760

See merge request GNOME/glib!797
This commit is contained in:
Philip Withnall 2019-04-29 10:50:05 +00:00
commit 4ceac0d40c
21 changed files with 70 additions and 64 deletions

View File

@ -727,24 +727,30 @@ typedef enum {
* the variant tuples returned. * the variant tuples returned.
* *
* %G_RESOLVER_RECORD_SRV records are returned as variants with the signature * %G_RESOLVER_RECORD_SRV records are returned as variants with the signature
* '(qqqs)', containing a guint16 with the priority, a guint16 with the * `(qqqs)`, containing a `guint16` with the priority, a `guint16` with the
* weight, a guint16 with the port, and a string of the hostname. * weight, a `guint16` with the port, and a string of the hostname.
* *
* %G_RESOLVER_RECORD_MX records are returned as variants with the signature * %G_RESOLVER_RECORD_MX records are returned as variants with the signature
* '(qs)', representing a guint16 with the preference, and a string containing * `(qs)`, representing a `guint16` with the preference, and a string containing
* the mail exchanger hostname. * the mail exchanger hostname.
* *
* %G_RESOLVER_RECORD_TXT records are returned as variants with the signature * %G_RESOLVER_RECORD_TXT records are returned as variants with the signature
* '(as)', representing an array of the strings in the text record. * `(as)`, representing an array of the strings in the text record. Note: Most TXT
* records only contain a single string, but
* [RFC 1035](https://tools.ietf.org/html/rfc1035#section-3.3.14) does allow a
* record to contain multiple strings. The RFC which defines the interpretation
* of a specific TXT record will likely require concatenation of multiple
* strings if they are present, as with
* [RFC 7208](https://tools.ietf.org/html/rfc7208#section-3.3).
* *
* %G_RESOLVER_RECORD_SOA records are returned as variants with the signature * %G_RESOLVER_RECORD_SOA records are returned as variants with the signature
* '(ssuuuuu)', representing a string containing the primary name server, a * `(ssuuuuu)`, representing a string containing the primary name server, a
* string containing the administrator, the serial as a guint32, the refresh * string containing the administrator, the serial as a `guint32`, the refresh
* interval as guint32, the retry interval as a guint32, the expire timeout * interval as a `guint32`, the retry interval as a `guint32`, the expire timeout
* as a guint32, and the ttl as a guint32. * as a `guint32`, and the TTL as a `guint32`.
* *
* %G_RESOLVER_RECORD_NS records are returned as variants with the signature * %G_RESOLVER_RECORD_NS records are returned as variants with the signature
* '(s)', representing a string of the hostname of the name server. * `(s)`, representing a string of the hostname of the name server.
* *
* Since: 2.34 * Since: 2.34
*/ */

View File

@ -52,8 +52,8 @@ g_proxy_default_init (GProxyInterface *iface)
* g_proxy_get_default_for_protocol: * g_proxy_get_default_for_protocol:
* @protocol: the proxy protocol name (e.g. http, socks, etc) * @protocol: the proxy protocol name (e.g. http, socks, etc)
* *
* Lookup "gio-proxy" extension point for a proxy implementation that supports * Find the `gio-proxy` extension point for a proxy implementation that supports
* specified protocol. * the specified protocol.
* *
* Returns: (transfer full): return a #GProxy or NULL if protocol * Returns: (transfer full): return a #GProxy or NULL if protocol
* is not supported. * is not supported.

View File

@ -498,7 +498,7 @@ g_settings_get_mapping (GValue *value,
return TRUE; return TRUE;
} }
g_warning ("Unable to lookup enum nick '%s' via GType", nick); g_warning ("Unable to look up enum nick %s via GType", nick);
return FALSE; return FALSE;
} }
} }