Difference between revisions of "LDC contributor's guide"

From D Wiki
Jump to: navigation, search
(Created page with "This page is a work-in-progress collection of tips for LDC contributors and development guidelines. == Style guidelines == * Use [http://llvm.org/docs/doxygen/html/ErrorHandl...")
 
(Style guidelines)
Line 2: Line 2:
  
 
== Style guidelines ==
 
== Style guidelines ==
* Use [http://llvm.org/docs/doxygen/html/ErrorHandling_8h.html#ace243f5c25697a1107cce46626b3dc94 ''llvm_unreachable("message")''] instead of ''assert(0 && "message")'' (from ''llvm/Support/ErrorHandling.h''). Not only might it lead to slightly better codegen, it also reduces
+
* Hard rules: 4 spaces for indentation, LF newlines.
 +
* Generally, use your good taste and try to use a style similar to the surrounding code. Many parts of the [http://llvm.org/docs/CodingStandards.html LLVM Coding Standards] are directly applicable to LDC as well.
 +
* Use [http://llvm.org/docs/doxygen/html/ErrorHandling_8h.html#ace243f5c25697a1107cce46626b3dc94 ''llvm_unreachable("message")''] instead of ''assert(0 && "message")'' (from ''llvm/Support/ErrorHandling.h''). Not only might it lead to slightly better codegen, it also prevents »variable might be used uninitialized« and similar compiler warnings.
  
 
[[Category:LDC]]
 
[[Category:LDC]]

Revision as of 18:55, 7 February 2013

This page is a work-in-progress collection of tips for LDC contributors and development guidelines.

Style guidelines

  • Hard rules: 4 spaces for indentation, LF newlines.
  • Generally, use your good taste and try to use a style similar to the surrounding code. Many parts of the LLVM Coding Standards are directly applicable to LDC as well.
  • Use llvm_unreachable("message") instead of assert(0 && "message") (from llvm/Support/ErrorHandling.h). Not only might it lead to slightly better codegen, it also prevents »variable might be used uninitialized« and similar compiler warnings.