summaryrefslogtreecommitdiff
path: root/fs/cifs/cifs_debug.h
diff options
context:
space:
mode:
authorSteve French <stfrench@microsoft.com>2018-10-07 21:52:18 +0300
committerSteve French <stfrench@microsoft.com>2018-10-24 05:16:05 +0300
commit8c1beb9801293b175cfa0341e5df89581a87dc02 (patch)
treea399807b82ca184cca04d06ded698f17b5d315f5 /fs/cifs/cifs_debug.h
parentf80eaedd6c5978fdd31549446cfa4a7212522b8d (diff)
downloadlinux-8c1beb9801293b175cfa0341e5df89581a87dc02.tar.xz
cifs: minor clarification in comments
Clarify meaning (in comments) meaning of various options for debug messages in cifs.ko. Also fixed trivial formatting/style issue with previous patch. Signed-off-by: Steve French <stfrench@microsoft.com>
Diffstat (limited to 'fs/cifs/cifs_debug.h')
-rw-r--r--fs/cifs/cifs_debug.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/fs/cifs/cifs_debug.h b/fs/cifs/cifs_debug.h
index 72db2987e066..631dc1bb21c1 100644
--- a/fs/cifs/cifs_debug.h
+++ b/fs/cifs/cifs_debug.h
@@ -47,6 +47,18 @@ extern int cifsFYI;
*/
#ifdef CONFIG_CIFS_DEBUG
+
+/*
+ * When adding tracepoints and debug messages we have various choices.
+ * Some considerations:
+ *
+ * Use cifs_dbg(VFS, ...) for things we always want logged, and the user to see
+ * cifs_info(...) slightly less important, admin can filter via loglevel > 6
+ * cifs_dbg(FYI, ...) minor debugging messages, off by default
+ * trace_smb3_* ftrace functions are preferred for complex debug messages
+ * intended for developers or experienced admins, off by default
+ */
+
/* Information level messages, minor events */
#define cifs_info_func(ratefunc, fmt, ...) \
do { \