diff options
| author | Zachary Turner <zturner@google.com> | 2016-08-11 18:10:40 +0000 |
|---|---|---|
| committer | Zachary Turner <zturner@google.com> | 2016-08-11 18:10:40 +0000 |
| commit | fd34ba53e34bfcdffde5fe0c12efab78381e2c73 (patch) | |
| tree | 2f6446e6bd22253e6c03184ac585affe4de63a91 /lldb | |
| parent | c4a12a08e2c91f44375c74bb64279ca42dabf21d (diff) | |
| download | bcm5719-llvm-fd34ba53e34bfcdffde5fe0c12efab78381e2c73.tar.gz bcm5719-llvm-fd34ba53e34bfcdffde5fe0c12efab78381e2c73.zip | |
Modify coding conventions to mention include ordering.
llvm-svn: 278373
Diffstat (limited to 'lldb')
| -rw-r--r-- | lldb/www/lldb-coding-conventions.html | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/lldb/www/lldb-coding-conventions.html b/lldb/www/lldb-coding-conventions.html index c3702decb31..7196576fee8 100644 --- a/lldb/www/lldb-coding-conventions.html +++ b/lldb/www/lldb-coding-conventions.html @@ -34,7 +34,20 @@ <b>Important</b>: Where not explicitly outlined below, assume that the <a href="http://llvm.org/docs/CodingStandards.html">LLVM Coding Conventions</a> are to be followed. </p> - + <h3>Include Order:</h3> + <p>LLDB follows <a href="http://llvm.org/docs/CodingStandards.html#include-style">LLVM's include order</a>, + with an addition for LLDB specific headers.</p> + <ol class="arabic simple" id="local-private-headers"> + <span id="main-module-header"></span> + <li>Main Module Header</li> + <li>Local/Private Headers</li> + <li><code class="docutils literal"><span class="pre">lldb/...</span></code></li> + <li><code class="docutils literal"><span class="pre">llvm/...</span></code></li> + <li>System <code class="docutils literal"><span class="pre">#include</span></code>s</li> + </ol> + <p>If you encounter existing code that does not follow this ordering, it should not be + taken as an indication that it is ok to not use it. Instead, the surrounding ordering + should be fixed gradually and incrementally.</p> <h3>Source code width:</h3> <p>lldb does not follow the 80 character line restriction llvm imposes. In our experience, trying to fit C++ code into an 80 character line results in code that |
