diff options
| author | Peter Collingbourne <peter@pcc.me.uk> | 2014-10-14 00:40:53 +0000 |
|---|---|---|
| committer | Peter Collingbourne <peter@pcc.me.uk> | 2014-10-14 00:40:53 +0000 |
| commit | 7c9c49b330e5e72671349a2de09ee01663e76b76 (patch) | |
| tree | 642a30c52900e1349dc2ebe8fa3cf351554f18df /docs/CodingStandards.rst | |
| parent | e0a0018345d4cc614f970b5b3f671ca6581a9eae (diff) | |
Introduce Go coding standards for LLVM.
Rather than define our own standards, we adopt a set of best practices that
are already in use by the Go community.
Differential Revision: http://reviews.llvm.org/D5761
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@219646 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CodingStandards.rst')
| -rw-r--r-- | docs/CodingStandards.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/CodingStandards.rst b/docs/CodingStandards.rst index 7aa28f346c52..0552c7117e2a 100644 --- a/docs/CodingStandards.rst +++ b/docs/CodingStandards.rst @@ -176,6 +176,25 @@ traits header to emulate it. .. _the libstdc++ manual: http://gcc.gnu.org/onlinedocs/gcc-4.7.3/libstdc++/manual/manual/status.html#status.iso.2011 +Other Languages +--------------- + +Any code written in the Go programming language is not subject to the +formatting rules below. Instead, we adopt the formatting rules enforced by +the `gofmt`_ tool. + +Go code should strive to be idiomatic. Two good sets of guidelines for what +this means are `Effective Go`_ and `Go Code Review Comments`_. + +.. _gofmt: + https://golang.org/cmd/gofmt/ + +.. _Effective Go: + https://golang.org/doc/effective_go.html + +.. _Go Code Review Comments: + https://code.google.com/p/go-wiki/wiki/CodeReviewComments + Mechanical Source Issues ======================== |