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 | e046199a717237ba802053b68c7b523bfd4d5f69 (patch) | |
| tree | 5e4016c548165a66ec8c338fa21e7bde4be7db36 /llvm/docs | |
| parent | 17045f7fac6b3345a4beae9fb495b2df6f1215a4 (diff) | |
| download | bcm5719-llvm-e046199a717237ba802053b68c7b523bfd4d5f69.tar.gz bcm5719-llvm-e046199a717237ba802053b68c7b523bfd4d5f69.zip | |
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
llvm-svn: 219646
Diffstat (limited to 'llvm/docs')
| -rw-r--r-- | llvm/docs/CodingStandards.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/llvm/docs/CodingStandards.rst b/llvm/docs/CodingStandards.rst index 7aa28f346c5..0552c7117e2 100644 --- a/llvm/docs/CodingStandards.rst +++ b/llvm/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 ======================== |
