linux/Documentation/process
Linus Torvalds 8ede842f66 Rust changes for v6.9
Another routine one in terms of features. We got two version upgrades
 this time, but in terms of lines, 'alloc' changes are not very large.
 
 Toolchain and infrastructure:
 
  - Upgrade to Rust 1.76.0.
 
    This time around, due to how the kernel and Rust schedules have
    aligned, there are two upgrades in fact. These allow us to remove two
    more unstable features ('const_maybe_uninit_zeroed' and
    'ptr_metadata') from the list, among other improvements.
 
  - Mark 'rustc' (and others) invocations as recursive, which fixes a new
    warning and prepares us for the future in case we eventually take
    advantage of the Make jobserver.
 
 'kernel' crate:
 
  - Add the 'container_of!' macro.
 
  - Stop using the unstable 'ptr_metadata' feature by employing the now
    stable 'byte_sub' method to implement 'Arc::from_raw()'.
 
  - Add the 'time' module with a 'msecs_to_jiffies()' conversion function
    to begin with, to be used by Rust Binder.
 
  - Add 'notify_sync()' and 'wait_interruptible_timeout()' methods to
    'CondVar', to be used by Rust Binder.
 
  - Update integer types for 'CondVar'.
 
  - Rename 'wait_list' field to 'wait_queue_head' in 'CondVar'.
 
  - Implement 'Display' and 'Debug' for 'BStr'.
 
  - Add the 'try_from_foreign()' method to the 'ForeignOwnable' trait.
 
  - Add reexports for macros so that they can be used from the right
    module (in addition to the root).
 
  - A series of code documentation improvements, including adding
    intra-doc links, consistency improvements, typo fixes...
 
 'macros' crate:
 
  - Place generated 'init_module()' function in '.init.text'.
 
 Documentation:
 
  - Add documentation on Rust doctests and how they work.
 -----BEGIN PGP SIGNATURE-----
 
 iQIzBAABCgAdFiEEPjU5OPd5QIZ9jqqOGXyLc2htIW0FAmXsZXsACgkQGXyLc2ht
 IW26LQ//QdJvnkqwrhijfFchTZSc1SuPPb88yeUveVv9Ve568EObkGuvlFKo+OLB
 vt16h+0/LFIW32ZbJ1GeXYsmztOjc3xfyUoSi0Le9jDcffiO+km1DRFAkTVTlYha
 18h01bJs/55JuIjU7UkKrxav6pNqBoNGOkkUvWdlitzqdw+kG0ad/7XiUomoAOI3
 AEibG2Vltr0DmazW2sZLs4Ae9ytOBPuyMeRoh8WaxiFWz/Rtq3qCNN9ww5Et9RKl
 7nhjoc6r2nweavE0oCilYhoFDl6fblhRUSGBCpF1nBOdG6KyrJswdAlv3xpncC/u
 TSZ+6N1BMn+xgPP4ftv0kG8TXm/AcInjiOlbOfnx+UX/R3laxfNrTrjpDzftc4Qm
 f+ygKefMClBCMHPlXu4OXCpL5C52p1GLK7q+q5PqF60P4qGoW6M3Vx6S8h9jT1oE
 kta+p0Rh3tz0YKwxPHcESuFdimkGh5+9zgAmbc3lKJ/uJ0AIdeEscriQn1S3xLF2
 De57l2iGO7OpMzV8T9hf4rQImTVOvd9zpoyPF0aMRymoxiy3kQtG8WVIkVixIDPW
 LKkoQif0Eh4r28rHBZ2Hvt5tC9ZYTSZP1MgDl8dQGi+5h4fmcN7WvcdciCYOPBRc
 em8ifLgCB77DuRhA6AWV5p0IgDDC0aHL6UAF8qm5vSyb6HcoGhE=
 =BAGo
 -----END PGP SIGNATURE-----

Merge tag 'rust-6.9' of https://github.com/Rust-for-Linux/linux

Pull Rust updates from Miguel Ojeda:
 "Another routine one in terms of features. We got two version upgrades
  this time, but in terms of lines, 'alloc' changes are not very large.

  Toolchain and infrastructure:

   - Upgrade to Rust 1.76.0

     This time around, due to how the kernel and Rust schedules have
     aligned, there are two upgrades in fact. These allow us to remove
     two more unstable features ('const_maybe_uninit_zeroed' and
     'ptr_metadata') from the list, among other improvements

   - Mark 'rustc' (and others) invocations as recursive, which fixes a
     new warning and prepares us for the future in case we eventually
     take advantage of the Make jobserver

  'kernel' crate:

   - Add the 'container_of!' macro

   - Stop using the unstable 'ptr_metadata' feature by employing the now
     stable 'byte_sub' method to implement 'Arc::from_raw()'

   - Add the 'time' module with a 'msecs_to_jiffies()' conversion
     function to begin with, to be used by Rust Binder

   - Add 'notify_sync()' and 'wait_interruptible_timeout()' methods to
     'CondVar', to be used by Rust Binder

   - Update integer types for 'CondVar'

   - Rename 'wait_list' field to 'wait_queue_head' in 'CondVar'

   - Implement 'Display' and 'Debug' for 'BStr'

   - Add the 'try_from_foreign()' method to the 'ForeignOwnable' trait

   - Add reexports for macros so that they can be used from the right
     module (in addition to the root)

   - A series of code documentation improvements, including adding
     intra-doc links, consistency improvements, typo fixes...

  'macros' crate:

   - Place generated 'init_module()' function in '.init.text'

  Documentation:

   - Add documentation on Rust doctests and how they work"

* tag 'rust-6.9' of https://github.com/Rust-for-Linux/linux: (29 commits)
  rust: upgrade to Rust 1.76.0
  kbuild: mark `rustc` (and others) invocations as recursive
  rust: add `container_of!` macro
  rust: str: implement `Display` and `Debug` for `BStr`
  rust: module: place generated init_module() function in .init.text
  rust: types: add `try_from_foreign()` method
  docs: rust: Add description of Rust documentation test as KUnit ones
  docs: rust: Move testing to a separate page
  rust: kernel: stop using ptr_metadata feature
  rust: kernel: add reexports for macros
  rust: locked_by: shorten doclink preview
  rust: kernel: remove unneeded doclink targets
  rust: kernel: add doclinks
  rust: kernel: add blank lines in front of code blocks
  rust: kernel: mark code fragments in docs with backticks
  rust: kernel: unify spelling of refcount in docs
  rust: str: move SAFETY comment in front of unsafe block
  rust: str: use `NUL` instead of 0 in doc comments
  rust: kernel: add srctree-relative doclinks
  rust: ioctl: end top-level module docs with full stop
  ...
2024-03-11 12:31:28 -07:00
..
1.Intro.rst
2.Process.rst docs: process: fix a typoed cross-reference 2023-05-20 08:07:04 -06:00
3.Early-stage.rst
4.Coding.rst Add .editorconfig file for basic formatting 2023-12-28 16:22:47 +09:00
5.Posting.rst docs: process: allow Closes tags with links 2023-04-18 16:39:31 -07:00
6.Followthrough.rst docs: remove the tips on how to submit patches from MAINTAINERS 2023-07-03 08:35:23 -06:00
7.AdvancedTopics.rst docs: try to encourage (netdev?) reviewers 2023-10-15 14:26:51 +01:00
8.Conclusion.rst
adding-syscalls.rst
applying-patches.rst
backporting.rst docs: backporting: address feedback 2023-10-26 11:49:16 -06:00
botching-up-ioctls.rst Documentation: Fix typos 2023-08-18 11:29:03 -06:00
changes.rst rust: upgrade to Rust 1.76.0 2024-02-29 22:18:05 +01:00
clang-format.rst
code-of-conduct-interpretation.rst docs: update mediator contact information in CoC doc 2022-11-10 18:45:11 +01:00
code-of-conduct.rst
coding-style.rst Add .editorconfig file for basic formatting 2023-12-28 16:22:47 +09:00
contribution-maturity-model.rst Documentation/process: Add Linux Kernel Contribution Maturity Model 2023-03-14 12:22:59 -06:00
cve.rst Documentation: Document the Linux Kernel CVE process 2024-02-17 14:46:39 +01:00
deprecated.rst docs: deprecated.rst: Update an example 2023-07-14 13:36:31 -06:00
development-process.rst docs: use toctree :caption: and move introduction 2023-11-17 13:05:26 -07:00
email-clients.rst Documentation: process: Document suitability of Proton Mail for kernel development 2023-01-13 09:26:19 -07:00
embargoed-hardware-issues.rst Documentation: embargoed-hardware-issues.rst: Clarify prenotifaction 2023-10-05 11:13:28 +02:00
handling-regressions.rst docs: handling-regressions: rework section about fixing procedures 2023-06-09 01:51:07 -06:00
howto.rst CREDITS, MAINTAINERS, docs/process/howto: Update man-pages' maintainer 2024-01-03 13:31:30 -07:00
index.rst Documentation: Document the Linux Kernel CVE process 2024-02-17 14:46:39 +01:00
kernel-docs.rst Documentation: Fix typos 2023-08-18 11:29:03 -06:00
kernel-driver-statement.rst
kernel-enforcement-statement.rst
license-rules.rst
magic-number.rst char: pcmcia: remove all the drivers 2023-03-09 17:30:27 +01:00
maintainer-handbooks.rst Documentation/process: maintainer-soc: add clean platforms profile 2023-08-12 14:04:51 +02:00
maintainer-kvm-x86.rst Documentation/process: Add a maintainer handbook for KVM x86 2023-06-22 14:25:38 -07:00
maintainer-netdev.rst docs: netdev: update the link to the CI repo 2024-02-20 11:52:41 +01:00
maintainer-pgp-guide.rst docs: maintainer-pgp-guide: update for latest gnupg defaults 2023-01-02 16:37:18 -07:00
maintainer-soc-clean-dts.rst Documentation/process: maintainer-soc: add clean platforms profile 2023-08-12 14:04:51 +02:00
maintainer-soc.rst Documentation/process: maintainer-soc: document dtbs_check requirement for Samsung 2023-08-12 14:05:34 +02:00
maintainer-tip.rst ARM64: 2023-07-03 15:32:22 -07:00
maintainers.rst
management-style.rst
programming-language.rst docs: programming-language: add Rust programming language section 2023-03-07 10:24:40 -07:00
researcher-guidelines.rst docs: Add a section on surveys to the researcher guidelines 2023-08-18 11:03:52 -06:00
security-bugs.rst Documentation: Document the Linux Kernel CVE process 2024-02-17 14:46:39 +01:00
stable-api-nonsense.rst
stable-kernel-rules.rst Documentation: stable: clarify patch series prerequisites 2023-10-05 13:43:45 +02:00
submit-checklist.rst
submitting-patches.rst docs: submitting-patches: improve the base commit explanation 2023-11-27 11:00:16 -07:00
volatile-considered-harmful.rst