[PATCH v4 02/18] RISC-V: Cleanup some of the sysdep.h code

[Maciej W. Rozycki]

On Tue, 18 Aug 2020, Carlos O'Donell wrote:

> >  Please comment #else:
> > 
> > #else /* !__ASSEMBLER__ */
> > 
> > especially as the conditional part above is very long.  Otherwise OK.
> > 
> >  This is not actually mentioned in our coding style document, unlike 
> > #endif, giving an impression we don't want #else statements commented: 
> > <https://sourceware.org/glibc/wiki/Style_and_Conventions#Commenting_.23endif>.  
> > This is however covered by the generic GNU Coding Standards document:
> > <https://www.gnu.org/prep/standards/standards.html#Comments>.
> > 
> >  Carlos: Do we want our wiki updated here?  ISTM we should.  WDYT?
> 
> Yes!
> 
> The GNU Coding Standard explains that we should comment #else, but doesn't
> say what kind of comment should be used, and that content is up to the
> project.
> 
> The section should cover how glibc is unique and what we expect from the
> #else comment.
> 
> Your suggestion looks good to me.

 I have updated the wiki then, thank you for your opinion.

 Also we don't explicitly mention #elif, but I think it can be implied 
that the convention followed for conditional parts beyond that directive 
is the same as with plain #if.

  Maciej