This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
Re: [RFC][PATCH 1/4][BZ 17083] getaddrinfo: Add comments for #else and #endif directives
On Tue, 12 Sep 2017, Andreas Schwab wrote:
> On Sep 12 2017, Joseph Myers <joseph@codesourcery.com> wrote:
>
> > On Mon, 11 Sep 2017, DJ Delorie wrote:
> >
> >> ?ukasz Stelmach <stlman@poczta.fm> writes:
> >> > #if __BYTE_ORDER == __BIG_ENDIAN
> >> > # define htonl_c(n) n
> >> > -#else
> >> > +#else /* __BYTE_ORDER == __BIG_ENDIAN */
> >> > # define htonl_c(n) __bswap_constant_32 (n)
> >> > -#endif
> >> > +#endif /* __BYTE_ORDER == __BIG_ENDIAN */
> >>
> >> What's our policy on inverting the logic sense in these comments when
> >> they refer to the #else clause?
> >
> > I'd expect comments to follow what the GNU Coding Standards say
> > ("@samp{#else} should have a comment describing the condition @emph{and
> > sense} of the code that follows.").
>
> But in this case the comment only clutters the source.
Yes, for a case like this where the #if contents are only one line,
comments are unhelpful as they just duplicate the obviously visible
semantics of the code.
--
Joseph S. Myers
joseph@codesourcery.com