Skip to content

Commit f8fa3f4

Browse files
committed
README: Make use of backticks
Denote special words/statements as code, by enclosing them in backticks. Signed-off-by: Cristian Ciocaltea <[email protected]>
1 parent 4be70e0 commit f8fa3f4

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ This plugin is meant to help you respecting the Linux kernel coding style,
44
described at: https://www.kernel.org/doc/Documentation/process/coding-style.rst
55
HTML rendering: https://www.kernel.org/doc/html/latest/process/coding-style.html
66

7-
It will automatically apply known rules to kernel related files, such as .c,
8-
.h, Kconfig and patch files. The main rules are about indentation and syntax
7+
It will automatically apply known rules to kernel related files, such as `.c`,
8+
`.h`, `Kconfig` and patch files. The main rules are about indentation and syntax
99
error highlighting (like exceeding 100 chars).
1010

1111
The original plugin was written by Vivien Didelot, developed in this
@@ -19,7 +19,7 @@ The current development location for this repo can be found in this
1919

2020
## Installation
2121

22-
You can just drop the linuxsty.vim file in your ~/.vim/plugin directory.
22+
You can just drop the `linuxsty.vim` file in your `~/.vim/plugin` directory.
2323
Alternatively you can use the Git repository with a manager such as
2424
[Pathogen](https://github.com/tpope/vim-pathogen).
2525

@@ -28,22 +28,22 @@ Alternatively you can use the Git repository with a manager such as
2828
By default the Linux coding style is enabled for any file known to the Linux
2929
project (C files, headers, patches, Kconfig, etc.).
3030

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

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

3838
If you want to save the current file's directory and automatically call
39-
LinuxCodingStyle next time, you can define the following option in your
40-
vimrc:
39+
`:LinuxCodingStyle` next time, you can define the following option in your
40+
`vimrc`:
4141

4242
let g:linuxsty_save_path = 1
4343

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

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

0 commit comments

Comments
 (0)