From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) by finch.gentoo.org (Postfix) with ESMTP id BD2F91381F3 for ; Sat, 24 Aug 2013 01:04:43 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 78DC5E0D34; Sat, 24 Aug 2013 01:04:40 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id BF1DDE0D14 for ; Sat, 24 Aug 2013 01:04:39 +0000 (UTC) Received: from hornbill.gentoo.org (hornbill.gentoo.org [94.100.119.163]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 9E26B33EBD4 for ; Sat, 24 Aug 2013 01:04:38 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by hornbill.gentoo.org (Postfix) with ESMTP id 52841E468F for ; Sat, 24 Aug 2013 01:04:37 +0000 (UTC) From: "Robin H. Johnson" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Robin H. Johnson" Message-ID: <1377305469.edfdd06aeecc784104e6eeba6ab227cae49c40d7.robbat2@OpenRC> Subject: [gentoo-commits] proj/netifrc:master commit in: / X-VCS-Repository: proj/netifrc X-VCS-Files: STYLE X-VCS-Directories: / X-VCS-Committer: robbat2 X-VCS-Committer-Name: Robin H. Johnson X-VCS-Revision: edfdd06aeecc784104e6eeba6ab227cae49c40d7 X-VCS-Branch: master Date: Sat, 24 Aug 2013 01:04:37 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Archives-Salt: ddbd2a0b-c6de-471e-97d0-a1870b03afa6 X-Archives-Hash: 6181a907730ad423688199f1b3c16fef commit: edfdd06aeecc784104e6eeba6ab227cae49c40d7 Author: Robin H. Johnson gentoo org> AuthorDate: Sat Aug 24 00:39:27 2013 +0000 Commit: Robin H. Johnson gentoo org> CommitDate: Sat Aug 24 00:51:09 2013 +0000 URL: http://git.overlays.gentoo.org/gitweb/?p=proj/netifrc.git;a=commit;h=edfdd06a We are sticking to the OpenRC style guide. Signed-off-by: Robin H. Johnson gentoo.org> --- STYLE | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) diff --git a/STYLE b/STYLE new file mode 100644 index 0000000..666ad28 --- /dev/null +++ b/STYLE @@ -0,0 +1,89 @@ +This STYLE file taken directly from OpenRC, and based on the heritage of +netifrc, we are sticking to it. + +==== Original file beyond this point. +This is the openrc style manual. It governs the coding style of all code +in this repository. Follow it. Contact openrc@gentoo.org for any questions +or fixes you might notice. + +########## +# C CODE # +########## + +The BSD Kernel Normal Form (KNF) style is used: + http://en.wikipedia.org/wiki/Indent_style#BSD_KNF_style +Basically, it's like K&R/LKML, but wrapped lines that are indented use 4 spaces. + +Highlights: + - no trailing whitespace + - indented code use tabs (not line wrapped) + - cuddle the braces (except for functions) + - space after native statements and before paren (for/if/while/...) + - no space between function and paren + - pointer asterisk cuddles the variable, not the type + +void foo(int c) +{ + int ret = 0; + + if (c > 1000) + return; + + while (c--) { + bar(c); + ret++; + } + + return ret; +} + +################## +# COMMIT MESSAGES # +################## + +The following is an example of a correctly formatted git commit message +for this repository. Most of this information came from this blog post +[1], so I would like to thank the author. + +### cut here ### +Capitalized, short (50 chars or less) summary + +More detailed explanatory text, if necessary. Wrap it to about 72 +characters or so. In some contexts, the first line is treated as the +subject of an email and the rest of the text as the body. The blank +line separating the summary from the body is critical (unless you omit +the body entirely); tools like rebase can get confused if you run the +two together. + +Write your commit message in the imperative: "Fix bug" and not "Fixed +bug." This convention matches up with commit messages generated by +commands like git merge and git revert. + +Further paragraphs come after blank lines. + +- Bullet points are okay, too + +- Typically a hyphen or asterisk is used for the bullet, preceded by a + single space, with blank lines in between, but conventions vary here + +- Use a hanging indent + +Reported-by: User Name +X-[Distro]-Bug: BugID +X-[Distro]-Bug-URL: URL for the bug (on the distribution's web site typically) +### cut here ### + +If you did not write the code and the patch does not include authorship +information in a format git can use, please use the --author option of the +git commit command to make the authorship correct. + +The Reported-by tag is required if the person who reported the bug is +different from the author and committer. + + The X-[Distro]-Bug/Bug-URL tags are required if this commit is related + to a bug reported to us by a specific distribution of linux or a + *BSD. Also, [Distro] should be replaced with the name of the + distribution, e.g. X-Gentoo-Bug. + +[1] http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +