Re: udp address setting docs are bad.

> On Fri, Oct 12, 2007, Amos Jeffries wrote:
>> The squid.conf docs for udp_incoming_address specify that its ICP-only
>> related.
>> However the Config.Addrs.udp_incoming is used by ICP, HTCP, and DNS.
>>
>> Similarly, docs for udp_outgoing_address specify that its ICP-only
>> related.
>> However the Config.Addrs.udp_outgoing is used by ICP, HTCP, syslog, and
>> DNS.
>>
>> This is from the 2.6 docs, I haven't checked 3.0, but its likely the
>> same.
>>
>> Anyone have suggestions on what should be said?
>
> Ah, language ambiguity. I mean "document what the option does."
>

Well, of course. I meant the specific verbage.
For example; heres What I've thrown at it so far:

NAME: udp_incoming_address
TYPE: address
LOC:Config.Addrs.udp_incoming
DEFAULT: 0.0.0.0
DOC_START
        udp_incoming_address is used for UDP packets received from other
                                caches.

        The default behavior is to not bind to any specific address.

        Only change this if you want to have all UDP queries received on
        a specific interface/addres.

        NOTE: udp_incoming_address is used by the ICP, HTCP, and DNS
        modules. Altering it will affect all of them in the same manner.

        see also; udp_outgoing_address

        NOTE, udp_incoming_address and udp_outgoing_address can not
        have the same value since they both use the same port.
DOC_END

NAME: udp_outgoing_address
TYPE: address
LOC: Config.Addrs.udp_outgoing
DEFAULT: 255.255.255.255
DOC_START
        udp_outgoing_address is used for UDP packets sent out to other
                                caches.

        The default behavior is to not bind to any specific address.

        Instead it will use the same socket as udp_incoming_address.
        Only change this if you want to have UDP queries sent using another
        address than where this Squid listens for UDP queries from other
        caches.

        NOTE: udp_outgoing_address is used by the ICP, HTCP, DNS, and syslog
        modules. Altering it will affect all of them in the same manner.

        see also; udp_incoming_address

        NOTE, udp_incoming_address and udp_outgoing_address can not
        have the same value since they both use the same port.
DOC_END

Amos
Received on Thu Oct 11 2007 - 20:16:17 MDT