Skip to contentSkip to conversation

docs: programming-language: remove mention of the Intel compiler

PATCH In review Miguel Ojeda 4 participants 5 messages Mar 6, 2023 – Mar 7, 2023

Subsystems (3)
Documentation Rust Documentation process
lore
Share & tools
lore

Miguel Ojeda

author maintainer
#0 lore raw

PATCH 1/2 docs: programming-language: remove mention of the Intel compiler

The Intel compiler support has been removed in commit 95207db8166a ("Remove Intel compiler support").

Thus remove its mention in the Documentation too.

Signed-off-by Miguel Ojeda <[email protected]>
---
 Documentation/process/programming-language.rst | 5 -----
 1 file changed, 5 deletions(-)
Documentation/process/programming-language.rst +0 -5
index 5fc9160ca1fa..10dc772671d8 100644
@@ -12,10 +12,6 @@ under ``-std=gnu11`` [gcc-c-dialect-options]_: the GNU dialect of ISO C11.
 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 ``icc`` [icc]_ for several
-of the architectures, although at the time of writing it is not completed,
-requiring third-party patches.
-
 Attributes
 ----------
 

@@ -38,7 +34,6 @@ 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

base-commit: fe15c26ee26efa11741a7b632e9f23b01aca4cc6

Signature · 1 line
2.39.2
author maintainer
#1 lore raw

PATCH 2/2 docs: programming-language: add Rust programming language section

Following the C text in the file, add a mention about the Rust programming language, the currently supported compiler and the edition used (similar to the "dialect" mention for C).

Similarly, add a mention about the unstable features used (similar to the "extensions" mentions for C).

In addition, add some links to complement the information.

Signed-off-by Miguel Ojeda <[email protected]>
---
 .../process/programming-language.rst          | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)
Documentation/process/programming-language.rst +18 -1
index 10dc772671d8..bc56dee6d0bc 100644
@@ -31,6 +31,20 @@ in order to feature detect which ones can be used and/or to shorten the code.
 
 Please refer to ``include/linux/compiler_attributes.h`` for more information.
 
+Rust
+----
+
+The kernel has experimental support for the Rust programming language
+[rust-language]_ under ``CONFIG_RUST``. It is compiled with ``rustc`` [rustc]_
+under ``--edition=2021`` [rust-editions]_. Editions are a way to introduce
+small changes to the language that are not backwards compatible.
+
+On top of that, some unstable features [rust-unstable-features]_ are used in
+the kernel. Unstable features may change in the future, thus it is an important
+goal to reach a point where only stable features are used.
+
+Please refer to Documentation/rust/index.rst 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

@@ -38,4 +52,7 @@ Please refer to ``include/linux/compiler_attributes.h`` for more information.
 .. [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
-
+.. [rust-language] https://www.rust-lang.org
+.. [rustc] https://doc.rust-lang.org/rustc/
+.. [rust-editions] https://doc.rust-lang.org/edition-guide/editions/
+.. [rust-unstable-features] https://github.com/Rust-for-Linux/linux/issues/2
Signature · 1 line
2.39.2
Reviewed-by on v1 1/2
#2 lore raw
In reply to Miguel Ojeda
Quoted 7 lines · Miguel Ojeda

The Intel compiler support has been removed in commit 95207db8166a ("Remove Intel compiler support").

Thus remove its mention in the Documentation too.

Signed-off-by Miguel Ojeda <[email protected]>

Thanks for the patch!

Reviewed-by Nick Desaulniers <[email protected]>
Quoted 32 lines
---
 Documentation/process/programming-language.rst | 5 -----
 1 file changed, 5 deletions(-)
Documentation/process/programming-language.rst +0 -5
index 5fc9160ca1fa..10dc772671d8 100644
@@ -12,10 +12,6 @@ under ``-std=gnu11`` [gcc-c-dialect-options]_: the GNU dialect of ISO C11.
 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 ``icc`` [icc]_ for several
-of the architectures, although at the time of writing it is not completed,
-requiring third-party patches.
-
 Attributes
 ----------
 

@@ -38,7 +34,6 @@ 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

base-commit: fe15c26ee26efa11741a7b632e9f23b01aca4cc6 --
2.39.2

Signature · 2 lines
Thanks,
~Nick Desaulniers
maintainer
#4 lore raw
In reply to Miguel Ojeda
Quoted 9 lines · Miguel Ojeda

The Intel compiler support has been removed in commit 95207db8166a ("Remove Intel compiler support").

Thus remove its mention in the Documentation too.

Signed-off-by Miguel Ojeda <[email protected]>
---
 Documentation/process/programming-language.rst | 5 -----
 1 file changed, 5 deletions(-)

Both patches applied, thanks.

jon