maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

Modify coding conventions to mention include ordering. 

llvm-svn: 278373
This commit is contained in:
Zachary Turner 2016-08-11 18:10:40 +00:00
parent c4a12a08e2
commit fd34ba53e3
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lldb/www/lldb-coding-conventions.html
View File

@ -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