summaryrefslogtreecommitdiffstats
path: root/tests/lcitool/libvirt-ci/containers/clang-format/README.rst
blob: 8f20ddb9c0791fd695d7c68495a5618f524828cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
===================================================
Container for running clang-format code style check
===================================================

This container provides a simple way to invoke ``clang-format`` to validate
code style across a C codebase. It should be integrated into a CI by adding
the following flag in ``ci/manifest.yml``

::

   gitlab:
     jobs:
       clang-format: true

or adding the following snippet to ``.gitlab-ci.yml``

::

   clang-format:
     stage: sanity_checks
     image: registry.gitlab.com/libvirt/libvirt-ci/clang-format:master
     needs: []
     script:
       - /clang-format
     artifacts:
       paths:
         - clang-format.patch
       expire_in: 1 week
       when: on_failure