[exim-dev] [Bug 2750] New: Documentation: readsocket: possib…

Top Page
Delete this message
Reply to this message
Author: admin
Date:  
To: exim-dev
Subject: [exim-dev] [Bug 2750] New: Documentation: readsocket: possible errors are listed, but matching sub strings for <fail string> are not
https://bugs.exim.org/show_bug.cgi?id=2750

            Bug ID: 2750
           Summary: Documentation: readsocket: possible errors are listed,
                    but matching sub strings for <fail string> are not
           Product: Exim
           Version: 4.94
          Hardware: All
               URL: http://exim.org/exim-html-current/doc/html/spec_html/c
                    h-string_expansions.html#SECTexpansionitems
                OS: All
            Status: NEW
          Severity: bug
          Priority: medium
         Component: Documentation
          Assignee: unallocated@???
          Reporter: u34@???
                CC: exim-dev@???


The context is: ${readsocket{<name>}{<request>}{<options>}{<eol string>}{<fail
string>}}

The reader has to guess, or look in the source code, or, perhaps, the manual
page, which sub string will match each error.
For example, does the example at the end matches a failure to create a socket
file descriptor?
A failure to connect the socket? Both? More? Some thing else?

$ grep -n --color ', the following errors can occur:' doc/doc-docbook/spec.xfpt
-A18
10581:addition, the following errors can occur:
10582-
10583-.ilist
10584-Failure to create a socket file descriptor;
10585-.next
10586-Failure to connect the socket;
10587-.next
10588-Failure to write the request string;
10589-.next
10590-Timeout on reading from the socket.
10591-.endlist
10592-
10593-By default, any of these errors causes the expansion to fail. However, if
10594-you supply a fifth substring, it is expanded and used when any of the
above
10595-errors occurs. For example:
10596-.code
10597-${readsocket{/socket/name}{request string}{3s}{\n}\
10598- {socket failure}}
10599-.endd

--
You are receiving this mail because:
You are on the CC list for the bug.