Policies/CMake Coding Style: Difference between revisions

    From KDE TechBase
    No edit summary
    (Replaced content with "{{Moved To Community}}")
     
    (14 intermediate revisions by 5 users not shown)
    Line 1: Line 1:
    This document describes the recommended coding style for CMake files in KDE, i.e. CMakeLists.txt files and *.cmake files.
    {{Moved To Community}}
     
    ==Indentation==
     
    Indent all code correctly, i.e. the body of
    * IF/ELSE/ENDIF
    * FOREACH/ENDFOREACH
    * WHILE/ENDWHILE
    * MACRO/ENDMACRO
    * FUNCTION/ENDFUNCTION (CMake 2.6)
     
    Use spaces for indenting, 2, 3 or 4 spaces preferably. Use the same amount
    of spaces for indenting as is used in the rest of the file.
     
    ==Upper/lower casing==
     
    CMake commands are case-insensitiv (only the commands, not the arguments or variable names). So all the following versions work:
    <code>
    add_executable(foo foo.c)
    ADD_EXECUTABLE(bar bar.c)
    Add_Executable(hello hello.c)
    aDd_ExEcUtAbLe(blub blub.c)
    </code>
     
    But this would be ugly.
     
    In KDE the ''all-lowercase style is preferred''. The all-uppercase style is also ok. Mixing upper- and lowercase should not be done in KDE CMake files.
    Although all-lowercase is preferred, if a file is apparently in all-uppercase style, then stay consistent and also use all-uppercase in this file.
     
    ==Writing CMake Find-modules==
     
    Follow the style guide from CMake when writing some FindFoo.cmake module:
    [http://www.cmake.org/cgi-bin/viewcvs.cgi/Modules/readme.txt?root=CMake&view=markup readme.txt]

    Latest revision as of 18:22, 10 March 2016

    This page is now on the community wiki.