docs/coding-style: add example vim config for clang-format
Signed-off-by: Eric Engestrom <eric@igalia.com> Reviewed-by: Alyssa Rosenzweig <alyssa@rosenzweig.io> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/23722>
This commit is contained in:

committed by
Marge Bot

parent
89873e5e5c
commit
342196f7b0
@@ -21,6 +21,34 @@ running ``ninja -C build/ clang-format``.
|
|||||||
Most code editors also support automatically formatting code as you
|
Most code editors also support automatically formatting code as you
|
||||||
write it; check your editor or its pluggins to see how to enable this.
|
write it; check your editor or its pluggins to see how to enable this.
|
||||||
|
|
||||||
|
Vim
|
||||||
|
***
|
||||||
|
|
||||||
|
Add this to your ``.vimrc`` to automatically format any C & C++ file
|
||||||
|
(that has a .clang-format config) when you save it:
|
||||||
|
|
||||||
|
.. code:: vim
|
||||||
|
|
||||||
|
augroup ClangFormatOnSave
|
||||||
|
au!
|
||||||
|
|
||||||
|
function! ClangFormatOnSave()
|
||||||
|
" Only format files that have a .clang-format in a parent folder
|
||||||
|
if !empty(findfile('.clang-format', '.;'))
|
||||||
|
let l:formatdiff = 1 " Only format lines that have changed
|
||||||
|
py3f /usr/share/clang/clang-format.py
|
||||||
|
endif
|
||||||
|
endfunction
|
||||||
|
|
||||||
|
autocmd BufWritePre *.h,*.c,*.cc,*.cpp call ClangFormatOnSave()
|
||||||
|
augroup END
|
||||||
|
|
||||||
|
If ``/usr/share/clang/clang-format.py`` doesn't exist, try
|
||||||
|
``/usr/share/clang/clang-format-$CLANG_VERSION/clang-format.py``
|
||||||
|
(replacing ``$CLANG_VERSION`` with your clang version). If your distro
|
||||||
|
has put the file somewhere else, look through the files in the package
|
||||||
|
providing ``clang-format``.
|
||||||
|
|
||||||
Basic formatting guidelines
|
Basic formatting guidelines
|
||||||
---------------------------
|
---------------------------
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user