Merge pull request #847 from ojeda/cleanups

treewide: cleanups and clarifications

Author: ojeda

Makefile

@@ -1716,8 +1716,9 @@ help:
 	@echo  '  rust-analyzer	  - Generate rust-project.json rust-analyzer support file'
 	@echo  '		    (requires kernel .config)'
 	@echo  '  dir/file.[os]   - Build specified target only'
-	@echo  '  dir/file.rsi    - Build macro expanded source, similar to C preprocessing'
-	@echo  '                    (run with RUSTFMT=n to skip reformatting if needed)'
+	@echo  '  dir/file.rsi    - Build macro expanded source, similar to C preprocessing.'
+	@echo  '                    Run with RUSTFMT=n to skip reformatting if needed.'
+	@echo  '                    The output is not intended to be compilable.'
 	@echo  '  dir/file.ll     - Build the LLVM assembly file'
 	@echo  ''
 	@$(if $(dtstree), \

drivers/android/transaction.rs

@@ -196,10 +196,10 @@ impl Transaction {
 
 impl DeliverToRead for Transaction {
     fn do_work(self: Ref<Self>, thread: &Thread, writer: &mut UserSlicePtrWriter) -> Result<bool> {
-        /* TODO: Initialise the following fields from tr:
-            pub sender_pid: pid_t,
-            pub sender_euid: uid_t,
-        */
+        // TODO: Initialise the following fields from `tr`:
+        //   - `pub sender_pid: pid_t`.
+        //   - `pub sender_euid: uid_t`.
+
         let send_failed_reply = ScopeGuard::new(|| {
             if self.node_ref.is_some() && self.flags & TF_ONE_WAY == 0 {
                 let reply = Either::Right(BR_FAILED_REPLY);

include/linux/compiler_types.h

@@ -4,6 +4,10 @@
 
 #ifndef __ASSEMBLY__
 
+/*
+ * Skipped when running bindgen due to a libclang issue;
+ * see https://github.com/rust-lang/rust-bindgen/issues/2244.
+ */
 #if defined(CONFIG_DEBUG_INFO_BTF) && defined(CONFIG_PAHOLE_HAS_BTF_TAG) && \
 	__has_attribute(btf_type_tag) && !defined(__BINDGEN__)
 # define BTF_TYPE_TAG(value) __attribute__((btf_type_tag(#value)))

include/linux/spinlock.h

@@ -338,11 +338,11 @@ static inline void __spin_lock_init(spinlock_t *lock, const char *name,
 	__raw_spin_lock_init(spinlock_check(lock), name, key, LD_WAIT_CONFIG);
 }
 
-# define spin_lock_init(lock)			\
-do {						\
-	static struct lock_class_key __key;	\
-						\
-	__spin_lock_init(lock, #lock, &__key);	\
+# define spin_lock_init(lock)					\
+do {								\
+	static struct lock_class_key __key;			\
+								\
+	__spin_lock_init(lock, #lock, &__key);			\
 } while (0)
 
 #else

rust/alloc/README.md

@@ -1,9 +1,9 @@
 # `alloc`
 
 These source files come from the Rust standard library, hosted in
-the https://github.com/rust-lang/rust repository, licensed under
+the <https://github.com/rust-lang/rust> repository, licensed under
 "Apache-2.0 OR MIT" and adapted for kernel use. For copyright details,
-see https://github.com/rust-lang/rust/blob/master/COPYRIGHT.
+see <https://github.com/rust-lang/rust/blob/master/COPYRIGHT>.
 
 Please note that these files should be kept as close as possible to
 upstream. In general, only additions should be performed (e.g. new

rust/alloc/boxed/thin.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
 // Based on
 // https://github.com/matthieu-m/rfc2580/blob/b58d1d3cba0d4b5e859d3617ea2d0943aaa31329/examples/thin.rs
 // by matthieu-m

rust/alloc/ffi/c_str.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
 #[cfg(test)]
 mod tests;
 

rust/alloc/ffi/mod.rs

@@ -1,3 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
 //! Utilities related to FFI bindings.
 //!
 //! This module provides utilities to handle data across non-Rust

rust/bindings/bindings_helper.h

@@ -13,6 +13,7 @@
 #include <linux/errname.h>
 #include <linux/file.h>
 #include <linux/fs.h>
+#include <linux/fs_parser.h>
 #include <linux/gpio/driver.h>
 #include <linux/hw_random.h>
 #include <linux/interrupt.h>
@@ -36,7 +37,6 @@
 #include <linux/uaccess.h>
 #include <linux/uio.h>
 #include <uapi/linux/android/binder.h>
-#include <linux/fs_parser.h>
 
 /* `bindgen` gets confused at certain things. */
 const gfp_t BINDINGS_GFP_KERNEL = GFP_KERNEL;

rust/bindings/lib.rs

@@ -10,7 +10,7 @@
 
 #![no_std]
 #![feature(core_ffi_c)]
-// See https://github.com/rust-lang/rust-bindgen/issues/1651.
+// See <https://github.com/rust-lang/rust-bindgen/issues/1651>.
 #![cfg_attr(test, allow(deref_nullptr))]
 #![cfg_attr(test, allow(unaligned_references))]
 #![cfg_attr(test, allow(unsafe_op_in_unsafe_fn))]