User Tools

Site Tools


dev:formattingconventions

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
dev:formattingconventions [2016/03/16 13:44] – Added subtitles, some rephrasing pseewalddev:formattingconventions [2020/08/21 10:15] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== Code Formatting Conventions and Prettify Tool ====== ====== Code Formatting Conventions and Prettify Tool ======
-Uniform formatting of CP2K source code will be enabled in the near future by a prettify script that is an almost complete auto-formatter for Fortran 90 source code. As a rule of thumb, developers should not worry about the format of their code and just let prettify do its magic by running ''make -j pretty''.+Uniform formatting of CP2K source code is enabled by a prettify script that is an almost complete auto-formatter for Fortran 90 source code. As a rule of thumb, developers should not worry about the format of their code and just let prettify do its magic by running ''make -j pretty''.
 ===== Formatting conventions ===== ===== Formatting conventions =====
 The following formatting conventions are automatically enforced by the ''make -j pretty'' command: The following formatting conventions are automatically enforced by the ''make -j pretty'' command:
Line 9: Line 9:
   * Removal of extraneous whitespace and consecutive blank lines.   * Removal of extraneous whitespace and consecutive blank lines.
   * Uppercase notation for all Fortran and OpenMP keywords.   * Uppercase notation for all Fortran and OpenMP keywords.
 +
 ===== Manual formatting ===== ===== Manual formatting =====
 The following formatting decisions are still manual and are never changed by prettify: The following formatting decisions are still manual and are never changed by prettify:
dev/formattingconventions.1458135842.txt.gz · Last modified: 2020/08/21 10:14 (external edit)