Do Use Whenever Possible

  • Locking and unlocking within a single subroutine.

  • A single point of exit from all subroutines. A goto is perfectly OK to use to get out early, but only to a label named bail_out, and possibly an ok_out. See current code examples.

  • malloc and free within a single subroutine.

  • Comments and global explanations on what your code or algorithm does.

  • When committing a fix for a bug, make the comment of the following form:

    Reason for bug fix or other message. Fixes bug #1234
    

    It is important to write the bug #1234 like that because our program that automatically pulls messages from the git repository to make the ChangeLog looks for that pattern. Obviously the 1234 should be replaced with the number of the bug you actually fixed.

    Providing the commit comment line has one of the following keywords (or phrases), it will be ignored:

    tweak
    typo
    cleanup
    bweb:
    regress:
    again
    .gitignore
    fix compilation
    technotes
    update version
    update technotes
    update kernstodo
    update projects
    update releasenotes
    update version
    update home
    update release
    update todo
    update notes
    update changelog
    
  • Use the following keywords at the beginning of a git commit message

Possible Next Steps

Go to Indenting Standards.

Go back to Developer Notes.

Go back to Developer Guide.