mcabber/CodingStyle.txt
author Mikael Berthe <mikael@lilotux.net>
Sun, 24 Oct 2021 21:20:36 +0200
changeset 2363 64f1899ff168
parent 2337 ffd0e57e9563
permissions -rw-r--r--
Fix format-security warnings This patch should fix the FTBFS report in Debian sid (bug 997162): the format string was omitted when displaying the message prefix and the mcabber version.

This document describes the preferred coding style for the mcabber project.

If you intend to patch and contribute to mcabber, please try to use the
existing style, and read the following points.

- Do not use tabs, use space characters;
- Avoid trailing whitespace;
- Avoid lines longer than 80 characters;
- Indentation is 2 spaces (ok, maybe it isn't a good idea but it's the
  current style);
- Defined types shall end with _t
- Put a space after non-functions statements (e.g. if, while...)
- Put the opening brace last on the same line, and put the closing brace first
  except for functions, where the opening brace should be alone on a new line.

  Example:

    void example(void)
    {
      if (cond1) {
        do_a();
      } else if (cond2) {
        do_b();
      } else {
        do_c();
      }

      if (error)
        exit(0);
    }

 - Look at existing code for rules not mentioned here.

Mikael