Skip to content
Snippets Groups Projects
Commit 89c8ffc5 authored by Thomas Bellman's avatar Thomas Bellman
Browse files

Better formatting of resolve_ipnets() doc string.

Don't try to markup flag key values by surrounding them with colons.
I don't really know where I got that idea from...
parent daf66931
No related branches found
No related tags found
No related merge requests found
...@@ -105,31 +105,34 @@ module Puppet::Parser::Functions ...@@ -105,31 +105,34 @@ module Puppet::Parser::Functions
- **Parameters** (in order): - **Parameters** (in order):
:netspecs: A network specification string, or a list of those. netspecs A network specification string, or a list of those.
:flags*: (Optional) Zero, one or more flags detailing the behaviour flags* (Optional) Zero, one or more flags detailing the behaviour
of resolve_ipnets(). Each flag is a string. The following flags of resolve_ipnets(). Each flag is a string. The following flags
are supported: are supported:
:"ipv4": Force lookup of hostnames as IPv4 addresses. "ipv4" Force lookup of hostnames as IPv4 addresses.
:"ipv6": Force lookup of hostnames as IPv6 addresses. "ipv6" Force lookup of hostnames as IPv6 addresses.
:"ignoreerrors": If an address cannot be resolved, return it "ignoreerrors"
unchanged. If an address cannot be resolved, return it unchanged.
:"failerrors": Raise an error if an address cannot be resolved. "failerrors"
This is the default behaviour. Raise an error if an address cannot be resolved. This is
the default behaviour.
:"stable": Always return addresses in the same order, regardless
of in which order the resolver returns them. The order relative "stable" Always return addresses in the same order, regardless
to the hostnames in the input will be preserved, so if the input of in which order the resolver returns them. The order
is ["host-a", "host-b"], then the addresses for host-a will come relative to the hostnames in the input will be preserved,
before those for host-b in the return value. so if the input is ["host-a", "host-b"], then the
NOTE: This breaks the address selection order (RFC 3484/6724) addresses for host-a will come before those for host-b in
that the getaddrinfo(3) function implements. the return value.
NOTE: The stable flag does not help aginst e.g. DNS servers NOTE: This breaks the address selection order (RFC 3484 /
responding with a different set of addresses each time. RFC 6724) that the getaddrinfo(3) function implements.
NOTE: The stable flag does not help aginst e.g. DNS
servers responding with a different set of addresses each
time.
Both "ipv4" and "ipv6" may be specified at the same time, in which Both "ipv4" and "ipv6" may be specified at the same time, in which
case both kinds of addresses will be returned, in the order the case both kinds of addresses will be returned, in the order the
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment