X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=CONTRIBUTING.md;h=0bebf12ef420fce860aaf07f4d57d77a5e4b47e7;hb=d17cc1f33c8bc03b375e5d6f602646fd87fba5ad;hp=04f5f0da58f5ee9b965500a98a58ed8a2857b4c4;hpb=a7a3543002579da4f6fb5a7621e39e03a45c5e94;p=lttng-tools.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 04f5f0da5..0bebf12ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,23 +15,7 @@ control. The upstream Git repository URL is: ## Coding standard -LTTng-tools uses the -[Linux kernel coding style](http://www.kernel.org/doc/Documentation/CodingStyle) -with one addition: single-line `if`/`for`/`while` statements must be -wrapped in braces. - -Example: - -~~~ c -/* not good */ -if (this == that) - goto fail; - -/* good */ -if (this == that) { - goto fail; -} -~~~ +See CodingStyle for guidelines style and design guidelines. Although the LTTng-tools code base is primarily written in C, it does contain shell, Perl, and Python code as well. There is no official coding @@ -67,10 +51,10 @@ submitting patches that apply to the LTTng-tools project. The patch's subject (the commit message's first line) should: - * begin with an uppercase letter - * be written in the present tense - * _not_ exceed 72 characters in length - * _not_ end with a period + * Begin with an uppercase letter. + * Be written in the present tense. + * _Not_ exceed 72 characters in length. + * _Not_ end with a period. In the case of bug fixes, the patch's subject must be prefixed with `Fix:` and a suitable sub-system name. For instance, a patch