LANG.STRUCT.DBG : Leftover Debug Code

Summary

A use of an output function, which may indicate a debugging trace statement unintentionally left in the code.

This class is a strict subset of Use of <stdio.h> Input/Output.

Properties

WARNING_FILTER += allow class="Leftover Debug Code"

Example

#include <fcntl.h>

int lang_struct_dbg(void){
    int ret;
    char filepath[256];
     
    ret = open("/usr/files/info.txt", O_RDONLY);
    if (!ret){
        puts("can't open info.txt"); /* 'Leftover Debug Code' warning issued here */
    }
    return ret;
}

Resolution

When you see a Leftover Debug Code warning, make sure that the output operation identified in the warning is not exposing information that users should not see. If so, you can change the warning state to Suppressed.

Relevant Configuration File Parameters

This class is implemented using a BAD_FUNCTION_* rule set in the general template configuration file.

• To include an additional function or set of functions in the checks for this class, create a new set of BAD_FUNCTION_* rules in which the BAD_FUNCTION_REGEX setting matches the function or set of functions you want to check and the remaining rules match those in the other sets for this class.
• To remove a function or set of functions from the checks for this class, edit the configuration file to comment out the corresponding set of BAD_FUNCTION_* rules.

The following configuration file parameters affect checks for this warning class.

• BAD_FUNCTION_BASE_RANK
• BAD_FUNCTION_CATEGORIES
• BAD_FUNCTION_INFO
• BAD_FUNCTION_LINK
• BAD_FUNCTION_MESSAGE
• BAD_FUNCTION_RANK
• BAD_FUNCTION_REGEX
• BAD_FUNCTION_SIGNIFICANCE
• REPORT_SIMILAR_WARNINGS
• WARNING_FILTER