| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Date: Sun, 21 Jan 2007 20:22:18 -0800
From: Randy Dunlap <randy.dunlap@...cle.com>
To: lkml <linux-kernel@...r.kernel.org>
Cc: rpjday@...dspring.com, akpm <akpm@...l.org>
Subject: [PATCH] fix various kernel-doc in header files
From: Robert P. J. Day <rpjday@...dspring.com>
Fix a number of kernel-doc entries for header files in
include/linux by making sure they begin with the appropriate '/**'
notation and use @var notation.
Signed-off-by: Robert P. J. Day <rpjday@...dspring.com>
Signed-off-by: Randy Dunlap <randy.dunlap@...cle.com>
---
include/linux/bitops.h | 6 ++----
include/linux/list.h | 10 +++++-----
include/linux/mutex.h | 2 +-
include/linux/rtmutex.h | 4 ++--
include/linux/timer.h | 4 ++--
5 files changed, 12 insertions(+), 14 deletions(-)
--- linux-2620-rc4.orig/include/linux/bitops.h
+++ linux-2620-rc4/include/linux/bitops.h
@@ -31,9 +31,8 @@ static inline unsigned long hweight_long
return sizeof(w) == 4 ? hweight32(w) : hweight64(w);
}
-/*
+/**
* rol32 - rotate a 32-bit value left
- *
* @word: value to rotate
* @shift: bits to roll
*/
@@ -42,9 +41,8 @@ static inline __u32 rol32(__u32 word, un
return (word << shift) | (word >> (32 - shift));
}
-/*
+/**
* ror32 - rotate a 32-bit value right
- *
* @word: value to rotate
* @shift: bits to roll
*/
--- linux-2620-rc4.orig/include/linux/list.h
+++ linux-2620-rc4/include/linux/list.h
@@ -227,13 +227,13 @@ static inline void list_replace_init(str
INIT_LIST_HEAD(old);
}
-/*
+/**
* list_replace_rcu - replace old entry by new one
* @old : the element to be replaced
* @new : the new element to insert
*
- * The old entry will be replaced with the new entry atomically.
- * Note: 'old' should not be empty.
+ * The @old entry will be replaced with the @new entry atomically.
+ * Note: @old should not be empty.
*/
static inline void list_replace_rcu(struct list_head *old,
struct list_head *new)
@@ -680,12 +680,12 @@ static inline void hlist_del_init(struct
}
}
-/*
+/**
* hlist_replace_rcu - replace old entry by new one
* @old : the element to be replaced
* @new : the new element to insert
*
- * The old entry will be replaced with the new entry atomically.
+ * The @old entry will be replaced with the @new entry atomically.
*/
static inline void hlist_replace_rcu(struct hlist_node *old,
struct hlist_node *new)
--- linux-2620-rc4.orig/include/linux/mutex.h
+++ linux-2620-rc4/include/linux/mutex.h
@@ -105,7 +105,7 @@ do { \
extern void __mutex_init(struct mutex *lock, const char *name,
struct lock_class_key *key);
-/***
+/**
* mutex_is_locked - is the mutex locked
* @lock: the mutex to be queried
*
--- linux-2620-rc4.orig/include/linux/rtmutex.h
+++ linux-2620-rc4/include/linux/rtmutex.h
@@ -16,7 +16,7 @@
#include <linux/plist.h>
#include <linux/spinlock_types.h>
-/*
+/**
* The rt_mutex structure
*
* @wait_lock: spinlock to protect the structure
@@ -71,7 +71,7 @@ struct hrtimer_sleeper;
#define DEFINE_RT_MUTEX(mutexname) \
struct rt_mutex mutexname = __RT_MUTEX_INITIALIZER(mutexname)
-/***
+/**
* rt_mutex_is_locked - is the mutex locked
* @lock: the mutex to be queried
*
--- linux-2620-rc4.orig/include/linux/timer.h
+++ linux-2620-rc4/include/linux/timer.h
@@ -41,7 +41,7 @@ static inline void setup_timer(struct ti
init_timer(timer);
}
-/***
+/**
* timer_pending - is a timer pending?
* @timer: the timer in question
*
@@ -63,7 +63,7 @@ extern int mod_timer(struct timer_list *
extern unsigned long next_timer_interrupt(void);
-/***
+/**
---
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
Powered by blists - more mailing lists