From: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
To: Linus Torvalds <torvalds@linux-foundation.org>
Cc: linux-kernel@vger.kernel.org,
Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
Rasmus Villemoes <linux@rasmusvillemoes.dk>,
Luc Van Oostenryck <luc.vanoostenryck@gmail.com>,
Eli Friedman <efriedma@codeaurora.org>,
Christopher Li <sparse@chrisli.org>,
Kees Cook <keescook@chromium.org>, Ingo Molnar <mingo@kernel.org>,
Geert Uytterhoeven <geert@linux-m68k.org>,
Arnd Bergmann <arnd@arndb.de>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Masahiro Yamada <yamada.masahiro@socionext.com>,
Joe Perches <joe@perches.com>,
Dominique Martinet <asmadeus@codewreck.org>,
Nick Desaulniers <ndesaulniers@google.com>,
linux-sparse@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH 12/12] Compiler Attributes: add Doc/process/programming-language.rst
Date: Mon, 3 Sep 2018 22:33:16 +0200 [thread overview]
Message-ID: <20180903203316.16183-13-miguel.ojeda.sandonis@gmail.com> (raw)
In-Reply-To: <20180903203316.16183-1-miguel.ojeda.sandonis@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Rasmus Villemoes <linux@rasmusvillemoes.dk>
Cc: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
Cc: Eli Friedman <efriedma@codeaurora.org>
Cc: Christopher Li <sparse@chrisli.org>
Cc: Kees Cook <keescook@chromium.org>
Cc: Ingo Molnar <mingo@kernel.org>
Cc: Geert Uytterhoeven <geert@linux-m68k.org>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Masahiro Yamada <yamada.masahiro@socionext.com>
Cc: Joe Perches <joe@perches.com>
Cc: Dominique Martinet <asmadeus@codewreck.org>
Cc: Nick Desaulniers <ndesaulniers@google.com>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: linux-sparse@vger.kernel.org
Cc: linux-doc@vger.kernel.org
Signed-off-by: Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
---
Documentation/process/index.rst | 1 +
.../process/programming-language.rst | 44 +++++++++++++++++++
2 files changed, 45 insertions(+)
create mode 100644 Documentation/process/programming-language.rst
diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst
index 37bd0628b6ee..c56f24a22d2a 100644
--- a/Documentation/process/index.rst
+++ b/Documentation/process/index.rst
@@ -23,6 +23,7 @@ Below are the essential guides that every developer should read.
code-of-conflict
development-process
submitting-patches
+ programming-language
coding-style
maintainer-pgp-guide
email-clients
diff --git a/Documentation/process/programming-language.rst b/Documentation/process/programming-language.rst
new file mode 100644
index 000000000000..674f28ae7f73
--- /dev/null
+++ b/Documentation/process/programming-language.rst
@@ -0,0 +1,44 @@
+.. _programming_language:
+
+Programming Language
+====================
+
+The kernel is written in the C programming language [c-language]_.
+More precisely, the kernel is typically compiled with ``gcc`` [gcc]_
+under ``-std=gnu89`` [gcc-c-dialect-options]_: the GNU dialect of ISO C90
+(including some C99 features).
+
+This dialect contains many extensions to the language [gnu-extensions]_,
+and many of them are used within the kernel as a matter of course.
+
+There is some support for compiling the kernel with ``clang`` [clang]_
+and ``icc`` [icc]_ for several of the architectures, although at the time
+of writing it is not completed, requiring third-party patches.
+
+Attributes
+----------
+
+One of the common extensions used throughout the kernel are attributes
+[gcc-attribute-syntax]_. Attributes allow to introduce
+implementation-defined semantics to language entities (like variables,
+functions or types) without having to make significant syntactic changes
+to the language (e.g. adding a new keyword) [n2049]_.
+
+In some cases, attributes are optional (i.e. a compiler not supporting them
+should still produce proper code, even if it is slower or does not perform
+as many compile-time checks/diagnostics).
+
+The kernel defines pseudo-keywords (e.g. ``__pure``) instead of using
+directly the GNU attribute syntax (e.g. ``__attribute__((pure))``).
+
+Please refer to ``include/linux/compiler_attributes.h`` for more information.
+
+.. [c-language] http://www.open-std.org/jtc1/sc22/wg14/www/standards
+.. [gcc] https://gcc.gnu.org
+.. [clang] https://clang.llvm.org
+.. [icc] https://software.intel.com/en-us/c-compilers
+.. [gcc-c-dialect-options] https://gcc.gnu.org/onlinedocs/gcc/C-Dialect-Options.html
+.. [gnu-extensions] https://gcc.gnu.org/onlinedocs/gcc/C-Extensions.html
+.. [gcc-attribute-syntax] https://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html
+.. [n2049] http://www.open-std.org/jtc1/sc22/wg14/www/docs/n2049.pdf
+
--
2.17.1
prev parent reply other threads:[~2018-09-03 20:34 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-09-03 20:33 [PATCH v3 00/12] Compiler Attributes Miguel Ojeda
2018-09-03 20:33 ` [PATCH 01/12] Compiler Attributes: remove unused attributes Miguel Ojeda
2018-09-03 20:33 ` [PATCH 02/12] Compiler Attributes: always use the extra-underscores syntax Miguel Ojeda
2018-09-03 20:33 ` [PATCH 03/12] Compiler Attributes: remove unneeded tests Miguel Ojeda
2018-09-03 20:33 ` [PATCH 04/12] Compiler Attributes: homogenize __must_be_array Miguel Ojeda
2018-09-03 20:33 ` [PATCH 05/12] Compiler Attributes: naked was fixed in gcc 4.6 Miguel Ojeda
2018-09-03 20:33 ` [PATCH 06/12] Compiler Attributes: naked can be shared Miguel Ojeda
2018-09-03 20:33 ` [PATCH 07/12] Compiler Attributes: remove unneeded sparse (__CHECKER__) tests Miguel Ojeda
2018-09-05 18:20 ` Luc Van Oostenryck
2018-09-05 19:30 ` Josh Triplett
2018-09-05 19:40 ` Linus Torvalds
2018-09-05 19:49 ` Luc Van Oostenryck
2018-09-03 20:33 ` [PATCH 08/12] Compiler Attributes: add missing SPDX ID in compiler_types.h Miguel Ojeda
2018-09-03 20:33 ` [PATCH 09/12] Compiler Attributes: use feature checks instead of version checks Miguel Ojeda
2018-09-03 20:33 ` [PATCH 10/12] Compiler Attributes: KENTRY used twice the "used" attribute Miguel Ojeda
2018-09-04 16:58 ` Nick Desaulniers
2018-09-03 20:33 ` [PATCH 11/12] Compiler Attributes: remove uses of __attribute__ from compiler.h Miguel Ojeda
2018-09-03 20:33 ` Miguel Ojeda [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180903203316.16183-13-miguel.ojeda.sandonis@gmail.com \
--to=miguel.ojeda.sandonis@gmail.com \
--cc=arnd@arndb.de \
--cc=asmadeus@codewreck.org \
--cc=corbet@lwn.net \
--cc=efriedma@codeaurora.org \
--cc=geert@linux-m68k.org \
--cc=gregkh@linuxfoundation.org \
--cc=joe@perches.com \
--cc=keescook@chromium.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-sparse@vger.kernel.org \
--cc=linux@rasmusvillemoes.dk \
--cc=luc.vanoostenryck@gmail.com \
--cc=mingo@kernel.org \
--cc=ndesaulniers@google.com \
--cc=sparse@chrisli.org \
--cc=torvalds@linux-foundation.org \
--cc=yamada.masahiro@socionext.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).