CMake
=====

We use `cmake-format <https://github.com/cheshirekow/cmake_format>`_ to format CMake files.

Usage
-----

Formatting a file:

.. code-block:: bash

    cmake-format -style=file -i <file_to_check>

Formatting several files at once:

.. code-block:: bash

    cmake-format -i $(find . -name CMakeLists.txt | sed '/3rdparty\/.*\/CMakeLists\.txt/d')

*-i* edits the files in-place.

For editor integration see :ref:`automatic_formatting`.

Configuration
-------------

Configuration is provided in the `.cmake-format` file:

.. sourceinclude:: ../../../.cmake-format
   :language: python