lkml.org 
[lkml]   [2018]   [Sep]   [9]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v4 12/13] Compiler Attributes: add Doc/process/programming-language.rst
On Sat,  8 Sep 2018 23:24:58 +0200
Miguel Ojeda <miguel.ojeda.sandonis@gmail.com> wrote:

> Documentation/process/index.rst | 1 +
> .../process/programming-language.rst | 45 +++++++++++++++++++
> 2 files changed, 46 insertions(+)
> create mode 100644 Documentation/process/programming-language.rst
>
So I have some overall thoughts on the documentation; my apologies for
not getting to this until you got to v4...

1) I think the document is mistitled. It's not really about the language
that the kernel used, it's about compiler attributes. So I would make
both the name of the document and it introduction reflect that.

2) This is an ideal opportunity to document what all of those attributes
actually mean. I would guess that is the information many developers
will come here looking for, and they'll go away frustrated. The ideal
thing to do, IMO, would be do say what each attribute means (rather
than just which compilers support it) in a DOC section in the new
compiler_attributes.h header, then use RST directives to pull all that
information into this document.

Thanks,

jon

\
 
 \ /
  Last update: 2018-09-09 20:20    [W:0.089 / U:53.160 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site