rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/2] docs: programming-language: remove mention of the Intel compiler
@ 2023-03-06 19:17 Miguel Ojeda
  2023-03-06 19:17 ` [PATCH 2/2] docs: programming-language: add Rust programming language section Miguel Ojeda
                   ` (3 more replies)
  0 siblings, 4 replies; 5+ messages in thread
From: Miguel Ojeda @ 2023-03-06 19:17 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: linux-doc, rust-for-linux, linux-kernel, patches, 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 <ojeda@kernel.org>
---
 Documentation/process/programming-language.rst | 5 -----
 1 file changed, 5 deletions(-)

diff --git a/Documentation/process/programming-language.rst b/Documentation/process/programming-language.rst
index 5fc9160ca1fa..10dc772671d8 100644
--- a/Documentation/process/programming-language.rst
+++ b/Documentation/process/programming-language.rst
@@ -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


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* [PATCH 2/2] docs: programming-language: add Rust programming language section
  2023-03-06 19:17 [PATCH 1/2] docs: programming-language: remove mention of the Intel compiler Miguel Ojeda
@ 2023-03-06 19:17 ` Miguel Ojeda
  2023-03-06 19:33 ` [PATCH 1/2] docs: programming-language: remove mention of the Intel compiler Nick Desaulniers
                   ` (2 subsequent siblings)
  3 siblings, 0 replies; 5+ messages in thread
From: Miguel Ojeda @ 2023-03-06 19:17 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: linux-doc, rust-for-linux, linux-kernel, patches, Miguel Ojeda

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 <ojeda@kernel.org>
---
 .../process/programming-language.rst          | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/Documentation/process/programming-language.rst b/Documentation/process/programming-language.rst
index 10dc772671d8..bc56dee6d0bc 100644
--- a/Documentation/process/programming-language.rst
+++ b/Documentation/process/programming-language.rst
@@ -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
-- 
2.39.2


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH 1/2] docs: programming-language: remove mention of the Intel compiler
  2023-03-06 19:17 [PATCH 1/2] docs: programming-language: remove mention of the Intel compiler Miguel Ojeda
  2023-03-06 19:17 ` [PATCH 2/2] docs: programming-language: add Rust programming language section Miguel Ojeda
@ 2023-03-06 19:33 ` Nick Desaulniers
  2023-03-06 19:35 ` Vincenzo Palazzo
  2023-03-07 17:25 ` Jonathan Corbet
  3 siblings, 0 replies; 5+ messages in thread
From: Nick Desaulniers @ 2023-03-06 19:33 UTC (permalink / raw)
  To: Miguel Ojeda
  Cc: Jonathan Corbet, linux-doc, rust-for-linux, linux-kernel, patches

On Mon, Mar 6, 2023 at 11:17 AM Miguel Ojeda <ojeda@kernel.org> wrote:
>
> 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 <ojeda@kernel.org>

Thanks for the patch!
Reviewed-by: Nick Desaulniers <ndesaulniers@google.com>

> ---
>  Documentation/process/programming-language.rst | 5 -----
>  1 file changed, 5 deletions(-)
>
> diff --git a/Documentation/process/programming-language.rst b/Documentation/process/programming-language.rst
> index 5fc9160ca1fa..10dc772671d8 100644
> --- a/Documentation/process/programming-language.rst
> +++ b/Documentation/process/programming-language.rst
> @@ -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
>


-- 
Thanks,
~Nick Desaulniers

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH 1/2] docs: programming-language: remove mention of the Intel compiler
  2023-03-06 19:17 [PATCH 1/2] docs: programming-language: remove mention of the Intel compiler Miguel Ojeda
  2023-03-06 19:17 ` [PATCH 2/2] docs: programming-language: add Rust programming language section Miguel Ojeda
  2023-03-06 19:33 ` [PATCH 1/2] docs: programming-language: remove mention of the Intel compiler Nick Desaulniers
@ 2023-03-06 19:35 ` Vincenzo Palazzo
  2023-03-07 17:25 ` Jonathan Corbet
  3 siblings, 0 replies; 5+ messages in thread
From: Vincenzo Palazzo @ 2023-03-06 19:35 UTC (permalink / raw)
  To: Miguel Ojeda, Jonathan Corbet
  Cc: linux-doc, rust-for-linux, linux-kernel, patches

> 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 <ojeda@kernel.org>
> ---

Reviewed-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH 1/2] docs: programming-language: remove mention of the Intel compiler
  2023-03-06 19:17 [PATCH 1/2] docs: programming-language: remove mention of the Intel compiler Miguel Ojeda
                   ` (2 preceding siblings ...)
  2023-03-06 19:35 ` Vincenzo Palazzo
@ 2023-03-07 17:25 ` Jonathan Corbet
  3 siblings, 0 replies; 5+ messages in thread
From: Jonathan Corbet @ 2023-03-07 17:25 UTC (permalink / raw)
  To: Miguel Ojeda
  Cc: linux-doc, rust-for-linux, linux-kernel, patches, Miguel Ojeda

Miguel Ojeda <ojeda@kernel.org> writes:

> 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 <ojeda@kernel.org>
> ---
>  Documentation/process/programming-language.rst | 5 -----
>  1 file changed, 5 deletions(-)

Both patches applied, thanks.

jon

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2023-03-07 17:30 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-03-06 19:17 [PATCH 1/2] docs: programming-language: remove mention of the Intel compiler Miguel Ojeda
2023-03-06 19:17 ` [PATCH 2/2] docs: programming-language: add Rust programming language section Miguel Ojeda
2023-03-06 19:33 ` [PATCH 1/2] docs: programming-language: remove mention of the Intel compiler Nick Desaulniers
2023-03-06 19:35 ` Vincenzo Palazzo
2023-03-07 17:25 ` Jonathan Corbet

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).