aka-mj / vim-linux-coding-style

Vim plugin to respect the Linux kernel coding style http://www.vim.org/scripts/script.php?script_id=4369

linuxsty.vim

This plugin is meant to help you respecting the Linux kernel coding style, described at: https://www.kernel.org/doc/Documentation/process/coding-style.rst

It will automatically apply known rules to kernel related files, such as .c, .h, Kconfig and patch files. The main rules are about indentation and syntax error highlighting (like exceeding 80 chars).

If you have any comments, fixes or requests, feel free to contact me or send me a patch. The development also takes place on its official Github repository.

The plugin is also available at vim.org, script ID 4369.

Installation

You can just drop the linuxsty.vim file in your ~/.vim/plugin directory. Alternatively you can use the Git repository with a manager such as Pathogen.

Usage

By default the Linux coding style is enabled for any file known to the Linux project (C files, headers, patches, Kconfig, etc.).

If you prefer a finer control and apply it only on some files, define a "g:linuxsty_patterns" array in your vimrc and the style will be applied only if the buffer's path matches one of the pattern. For instance, you can match only projects under /usr/src/ and /linux with the following:

let g:linuxsty_patterns = [ "/usr/src/", "/linux" ]

If you want to enable the coding style on demand without checking the filetype, you can use the :LinuxCodingStyle command. For instance, you can map it with the following in your vimrc:

nnoremap <silent> <leader>a :LinuxCodingStyle<cr>

License

Copyright (c) Vivien Didelot. Distributed under the same terms as Vim itself. See :help license.