linux-kernel - [PATCH 04/15] lru_cache: improve function-level documentation

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

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <1475351192-27079-5-git-send-email-Julia.Lawall@lip6.fr>
Date:   Sat,  1 Oct 2016 21:46:21 +0200
From:   Julia Lawall <Julia.Lawall@...6.fr>
To:     Philipp Reisner <philipp.reisner@...bit.com>
Cc:     kernel-janitors@...r.kernel.org,
        Lars Ellenberg <lars.ellenberg@...bit.com>,
        drbd-dev@...ts.linbit.com, linux-kernel@...r.kernel.org
Subject: [PATCH 04/15] lru_cache: improve function-level documentation

Use the actual function name and reorder the listed variables to correspond
to their order in the function parameter list.

Issue detected using Coccinelle (http://coccinelle.lip6.fr/)

Signed-off-by: Julia Lawall <Julia.Lawall@...6.fr>

---
 lib/lru_cache.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lib/lru_cache.c b/lib/lru_cache.c
index 28ba40b..07d3507 100644
--- a/lib/lru_cache.c
+++ b/lib/lru_cache.c
@@ -639,9 +639,9 @@ void lc_set(struct lru_cache *lc, unsigned int enr, int index)
 }
 
 /**
- * lc_dump - Dump a complete LRU cache to seq in textual form.
- * @lc: the lru cache to operate on
+ * lc_seq_dump_details - Dump a complete LRU cache to seq in textual form.
  * @seq: the &struct seq_file pointer to seq_printf into
+ * @lc: the lru cache to operate on
  * @utext: user supplied additional "heading" or other info
  * @detail: function pointer the user may provide to dump further details
  * of the object the lc_element is embedded in. May be NULL.