From: Ralph Corderoy <ralph@inputplus.co.uk>
Date: Sat, 22 Oct 2016 13:43:11 +0000 (+0100)
Subject: Document advise(), adios(), admonish(), and advertise().
X-Git-Url: https://diplodocus.org/git/nmh/commitdiff_plain/989be1fb92afdec3842ac931fdcbced29ab0ba39?hp=989be1fb92afdec3842ac931fdcbced29ab0ba39

Document advise(), adios(), admonish(), and advertise().

It doesn't make their design any better.  Their "ad" prefix goes against
common advice of having distinguishable identifiers to avoid mix-ups,
and seems to be a theme that got out of hand.  The out-of-order
parameters to advertise seem due to lack of strerror(3) that's no longer
a problem.

Before:
    advertise("open", "continuing...", "couldn't read profile: %s",
        path);
Could be:
    error("couldn't read profile: %s: open: %s, continuing...\n",
        path, strerror(errno));
And the "open" is typically dropped as superfluous so there's a
repetitive leading NULL passed a lot.
---