Merge pull request #574 from ferrocene/tshepang/document-1.88

document Rust 1.88 changes

Author: traviscross

src/attributes.rst

@@ -138,6 +138,7 @@ Built-in Attributes
      | LinkOrdinalContent
      | MacroExportContent
      | MacroUseContent
+     | NakedContent
      | NoBinutilsContent
      | NoImplicitPreludeContent
      | NoLinkContent
@@ -184,6 +185,9 @@ The following :t:`[built-in attribute]s` are :dt:`[code generation attribute]s`:
 * :dp:`fls_gxxbf6eag3et`
   :t:`Attribute` :c:`track_caller`.
 
+* :dp:`fls_eOJS3mxa9xgu`
+  :t:`Attribute` :c:`naked`.
+
 :dp:`fls_87o6n9et9jio`
 The following :t:`[built-in attribute]s` are
 :dt:`[conditional compilation attribute]s`:
@@ -682,6 +686,48 @@ the :t:`attribute`.
    #[track_caller]
    fn who_called_me () {}
 
+
+.. _fls_Sd6rUmpEb355:
+
+Attribute ``naked``
+^^^^^^^^^^^^^^^^^^^
+
+.. rubric:: Syntax
+
+.. syntax::
+
+   NakedContent ::=
+       $$naked$$
+
+.. rubric:: Legality Rules
+
+:dp:`fls_8eg0iN2diBZt`
+:t:`Attribute` :c:`naked` shall apply to :t:`[function]s`.
+
+:dp:`fls_WnqgR5OyecIs`
+:t:`Attribute` :dc:`naked` ensures that a :t:`function` prologue and epilogue are not generated.
+
+:dp:`fls_NCHa4Dc1M6oM`
+:t:`Attribute` :c:`naked` :t:`function body` must consist of exactly one
+:t:`macro` :std:`core::arch::naked_asm` call.
+
+:dp:`fls_H7ccwNk2HGAi`
+:t:`Attribute` :c:`naked` cannot be used together with :t:`[testing function]s`.
+
+:dp:`fls_ocOk47SGiRVb`
+:t:`Attribute` :c:`naked` cannot be used together with :t:`attribute` :c:`inline`.
+
+:dp:`fls_VUL2qySBvRqy`
+:t:`Attribute` :c:`naked` cannot be used together with :t:`attribute` :c:`track_caller`.
+
+.. rubric:: Undefined Behavior
+
+:dp:`fls_0tYMAQY1V55p`
+It is a :t:`safety invariant` for the :t:`function body` to respect the :t:`ABI` of the function.
+
+:dp:`fls_wGbJrz4OpKKb`
+It is a :t:`safety invariant` for the :t:`function body` to :t:`diverge <diverging expression>`.
+
 .. _fls_cdx9zb1yxcc8:
 
 Conditional Compilation Attributes
@@ -704,6 +750,8 @@ Attribute ``cfg``
      | ConfigurationPredicateAll
      | ConfigurationPredicateAny
      | ConfigurationPredicateNot
+     | $$true$$
+     | $$false$$
 
    ConfigurationOption ::=
        ConfigurationOptionName ConfigurationOptionValue?
@@ -760,6 +808,12 @@ negates the Boolean :t:`value` of its nested :t:`configuration predicate`.
 A :t:`not configuration predicate` evaluates statically to ``true`` when its
 nested configuration predicate evaluates to ``false``.
 
+:dp:`fls_JWx8vQwl19Fu`
+:t:`Configuration predicate` :dc:`true` always evaluates statically to ``true``.
+
+:dp:`fls_SziFAQsio0ab`
+:t:`Configuration predicate` :dc:`false` always evaluates statically to ``false``.
+
 :dp:`fls_jbl9xyynjo0g`
 The :t:`evaluation` of a configuration option is tool-defined.
 
@@ -1378,23 +1432,29 @@ Attribute ``unsafe``
 
 .. rubric:: Legality Rules
 
+:dp:`fls_z5DTDKM9mU3o`
+:t:`Attribute` :dc:`unsafe` is used to indicate that an  :t:`attribute` is :t:`unsafe <unsafe operation>`.
+
 :dp:`fls_5pjo3nGOxbVw`
 :t:`Attribute` :c:`unsafe` shall apply to what the contained :t:`attribute` applies to.
 
 :dp:`fls_gpxlWbQUNsj8`
-:t:`Attribute` :c:`unsafe` behaves like the contained :t:`attribute`.
+:t:`Attribute` :c:`unsafe` does not affect the behavior of the contained :t:`attribute`.
 
 :dp:`fls_PhrfxSBvXTPV`
-The contained :t:`attribute` shall be one of:
+The contained :t:`attribute` shall be one of the following:
 
 * :dp:`fls_pCSew95bKJJ5`
-  :t:`attribute` :c:`no_mangle`,
+  :t:`Attribute` :c:`no_mangle`
+
+* :dp:`fls_NRLgmOXxuljQ`
+  :t:`Attribute` :c:`export_name`
 
-  :dp:`fls_NRLgmOXxuljQ`
-  :t:`attribute` :c:`export_name`, or
+* :dp:`fls_ykpxNByUDyHG`
+  :t:`Attribute` :c:`link_section`
 
-  :dp:`fls_ykpxNByUDyHG`
-  :t:`attribute` :c:`link_section`,
+* :dp:`fls_2oP2nbDPtUg7`
+  :t:`Attribute` :c:`naked`
 
 .. rubric:: Examples
 

src/changelog.rst

@@ -18,6 +18,75 @@ with the change that has been applied due to it.
    just the language changes that had an impact to the FLS. See the `release
    notes`_ for a full list of changes.
 
+Language changes in Rust 1.88.0
+-------------------------------
+
+- `Stabilize let_chains feature in the 2024 edition <https://github.com/rust-lang/rust/pull/132833>`_
+
+  - No change: the FLS only supports the 2021 edition
+
+- `Stabilize naked_functions feature <https://github.com/rust-lang/rust/pull/134213>`_
+
+  - New sections: :ref:`fls_Sd6rUmpEb355`
+
+  - New paragraphs:
+
+    - :p:`fls_eOJS3mxa9xgu`
+
+    - :p:`fls_2oP2nbDPtUg7`
+
+    - :p:`fls_y2wCBvXDtQK2`
+
+    - :p:`fls_PEoOGTBjuEQc`
+
+    - :p:`fls_vcB5xwgD6Ign`
+
+  - Changed paragraphs:
+
+    - :p:`fls_3fg60jblx0xb`
+
+    - :p:`fls_ecteot716j8j`
+
+    - :p:`fls_tgzga1lanfuo`
+
+    - :p:`fls_g09kmp2a04g9`
+
+    - :p:`fls_nszx1gllufi2`
+
+  - New syntax: :s:`SymPathExpression`
+
+  - Changed syntax:
+
+    - :s:`RegisterArgument`
+
+    - :s:`RegisterExpression`
+
+    - :s:`BuiltinAttributeContent`
+
+- `Stabilize cfg_boolean_literals feature <https://github.com/rust-lang/rust/pull/138632>`_
+
+  - Changed syntax: :s:`ConfigurationPredicate`
+
+- `Fully de-stabilize the #[bench] attribute <https://github.com/rust-lang/rust/pull/134273)>`_
+
+  - No change: this was an unstable feature and was therefore not specified in the FLS
+
+- `Add warn-by-default dangerous_implicit_autorefs lint against implicit autoref of raw pointer dereference <https://github.com/rust-lang/rust/pull/123239>`_
+
+  - No change: lints are not part of the FLS
+
+- `Add invalid_null_arguments lint to prevent invalid usage of null pointers <https://github.com/rust-lang/rust/pull/119220>`_
+
+  - No change: lints are not part of the FLS
+
+- `Change trait impl candidate preference for builtin impls and trivial where-clauses. <https://github.com/rust-lang/rust/pull/138176>`_
+
+  - No change: trait impl candidate preference is not specified in the FLS
+
+- `Check types of generic const parameter defaults <https://github.com/rust-lang/rust/pull/139646>`_
+
+  - No change: this bug was not documented in the FLS
+
 Language changes in Rust 1.87.0
 -------------------------------
 

src/inline-assembly.rst

@@ -18,8 +18,10 @@ Rust program.
 
 :dp:`fls_3fg60jblx0xb`
 :t:`Inline assembly` is written as an :t:`assembly code block` that is
-wrapped inside a :t:`macro invocation` of :t:`macro` :std:`core::arch::asm` or
-:t:`macro` :std:`core::arch::global_asm`.
+wrapped inside a :t:`macro invocation` of
+:t:`macro` :std:`core::arch::asm`,
+:t:`macro` :std:`core::arch::global_asm`, or
+:t:`macro` :std:`core::arch::naked_asm`.
 
 :dp:`fls_helnk2iz8qhp`
 :t:`Inline assembly` is available on the following architectures:
@@ -604,7 +606,7 @@ Register Arguments
 .. syntax::
 
    RegisterArgument ::=
-       (Identifier $$=$$)? DirectionModifier $$($$ RegisterName $$)$$ RegisterExpression
+       (Identifier $$=$$)? ( DirectionModifier $$($$ RegisterName $$)$$ )? RegisterExpression
 
    DirectionModifier ::=
        $$in$$
@@ -617,6 +619,7 @@ Register Arguments
        InputOutputRegisterExpression
      | SimpleRegisterExpression
      | ConstRegisterExpression
+     | SymPathExpression
 
    InputOutputRegisterExpression ::=
        InputRegisterExpression $$=>$$ OutputRegisterExpression
@@ -635,6 +638,9 @@ Register Arguments
    ConstRegisterExpression ::=
        $$const$$ Expression
 
+   SymPathExpression ::=
+       $$sym$$ PathExpression
+
 .. rubric:: Legality Rules
 
 :dp:`fls_455dmnp4cxqv`
@@ -703,6 +709,10 @@ A :t:`register expression` is either an :t:`input-output register expression`, a
 :dp:`fls_jU8zg4k8dFsY`
 The :t:`type` of a :t:`const register expression` shall be an :t:`integer type`.
 
+:dp:`fls_y2wCBvXDtQK2`
+A :dt:`sym path expression` is a way for the :t:`assembly code block` to refer either to
+a :t:`function` :t:`name` or a :t:`static` :t:`name`.
+
 :dp:`fls_66owmltvhnu4`
 The :t:`type` of an :t:`input register expression`,
 :t:`output register expression`, or :t:`simple register expression` shall
@@ -1484,7 +1494,7 @@ An :t:`assembly option` is used to specify a characteristic of or a restriction
 on the related :t:`assembly code block`.
 
 :dp:`fls_g09kmp2a04g9`
-:t:`Assembly option` ``att_syntax`` is applicable only to x86 architectures
+:t:`Assembly option` :dc:`att_syntax` is applicable only to x86 architectures
 and causes the assembler to use the ``.att_syntax`` prefix mode which prefixes
 :t:`[register]s` with ``%``.
 
@@ -1561,7 +1571,7 @@ of the following flags :t:`[register]s` shall be restored on exit from an
 side effects, and its outputs depend only on direct inputs.
 
 :dp:`fls_nszx1gllufi2`
-:t:`Assembly option` ``raw`` causes :t:`[assembly instruction]s` to be parsed
+:t:`Assembly option` :dc:`raw` causes :t:`[assembly instruction]s` to be parsed
 raw, without any special handling of :t:`[register parameter]s`.
 
 :dp:`fls_d169ppna563c`
@@ -1607,8 +1617,8 @@ It is undefined behavior if control reaches the end of an
 
 .. _fls_qezwyridmjob:
 
-Macros asm and global_asm
--------------------------
+Macros: asm, global_asm, and naked_asm
+--------------------------------------
 
 .. rubric:: Syntax
 
@@ -1627,7 +1637,9 @@ Macros asm and global_asm
 
 :dp:`fls_ecteot716j8j`
 :t:`[Assembly code block]s` are embedded within Rust source code using
-:t:`[macro]s` :std:`core::arch::asm` and :std:`core::arch::global_asm`.
+:t:`[macro]s` :std:`core::arch::asm`,
+:std:`core::arch::global_asm`, and
+:std:`core::arch::naked_asm`.
 
 :dp:`fls_1ikzov7cxic1`
 When invoking :t:`macro` :std:`core::arch::asm`, the :s:`DelimitedTokenTree` of
@@ -1641,7 +1653,8 @@ encapsulate the :t:`assembly code block` in a separate :t:`function` and
 generate a :t:`call expression` to it.
 
 :dp:`fls_tgzga1lanfuo`
-When invoking :t:`macro` :std:`core::arch::global_asm`, the
+When invoking :t:`macro` :std:`core::arch::global_asm` and
+:t:`macro` :std:`core::arch::naked_asm`, the
 :s:`DelimitedTokenTree` of the related :t:`macro invocation` shall follow the
 syntax of :s:`GlobalAsmArguments`.
 
@@ -1650,6 +1663,15 @@ Invoking :t:`macro` :std:`core::arch::global_asm` causes the related
 :t:`assembly code block` to be emitted outside the :t:`function` where the
 :t:`macro invocation` took place.
 
+:dp:`fls_PEoOGTBjuEQc`
+The only :t:`[register argument]s` that can be used with :t:`[macro]s`
+:std:`core::arch::global_asm` and :std:`core::arch::naked_asm` are
+:t:`const <const register expression>` and :t:`sym <sym path expression>`.
+
+:dp:`fls_vcB5xwgD6Ign`
+The only :t:`[assembly option]s` that can be used with :t:`[macro]s`
+:std:`core::arch::global_asm` and :std:`core::arch::naked_asm` are :c:`att_syntax` and :c:`raw`.
+
 .. rubric:: Dynamic Semantics
 
 :dp:`fls_98vyqh9bzigx`