From 0eaae1a87fee60675d8d9f48f8a5f5cb583f0e14 Mon Sep 17 00:00:00 2001 From: Volker Lendecke Date: Fri, 1 Nov 2013 12:04:38 +0000 Subject: README.Coding: Add __func__ Signed-off-by: Volker Lendecke Reviewed-by: Michael Adam Autobuild-User(master): Michael Adam Autobuild-Date(master): Mon Nov 11 16:08:09 CET 2013 on sn-devel-104 --- README.Coding | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'README.Coding') diff --git a/README.Coding b/README.Coding index 956a733a4c..107856e45f 100644 --- a/README.Coding +++ b/README.Coding @@ -377,3 +377,17 @@ do not use them in new code. The only exception is the test code that depends repeated use of calls like CHECK_STATUS, CHECK_VAL and others. + + +Function names in DEBUG statements +---------------------------------- + +Many DEBUG statements contain the name of the function they appear in. This is +not a good idea, as this is prone to bitrot. Function names change, code +moves, but the DEBUG statements are not adapted. Use %s and __func__ for this: + +Bad Example: + DEBUG(0, ("strstr_m: src malloc fail\n")); + +Good Example: + DEBUG(0, ("%s: src malloc fail\n", __func__)); -- cgit