@@ -87,7 +87,52 @@ Notes:
87
87
-c ' :set runtimepath^=~/.vim/bundle/vim-erlang-runtime/'
88
88
```
89
89
90
- # # Development and testing the indentation script
90
+ # # Development
91
+
92
+ # ## Erlang-related files in Vim
93
+
94
+ The Vim repository contains the following Erlang-related files:
95
+
96
+ < ! -- If you edit the list, please maintain the alphabetical order. -->
97
+
98
+ * [` runtime/compiler/erlang.vim` ][vim-src/runtime/compiler/erlang.vim]:
99
+ Allows simple Erlang files to be compiled after calling ` :compiler erlang` .
100
+ ` vim-erlang-compiler` has a similar but broader scope.
101
+
102
+ * [` runtime/doc/syntax.txt` ][vim-src/runtime/doc/syntax.txt]:
103
+ Contains documentation about configuring ` runtime/syntax/erlang.vim` .
104
+
105
+ * [` runtime/filetype.vim` ][vim-src/runtime/filetype.vim]:
106
+ Sets the file type to ` erlang` if the file name matches either ` * .erl` ,
107
+ ` * .hrl` or ` * .yaws` . The list of patterns is a subset of the patterns in
108
+ ` ftdetect/erlang.vim` in this repository.
109
+
110
+ * [` runtime/ftplugin/erlang.vim` ][vim-src/runtime/ftplugin/erlang.vim]:
111
+ Same as ` ftplugin/erlang.vim` in this repository.
112
+
113
+ * [` runtime/indent/erlang.vim` ][vim-src/runtime/indent/erlang.vim]:
114
+ Same as ` indent/erlang.vim` in this repository.
115
+
116
+ * [` runtime/makemenu.vim` ][vim-src/runtime/makemenu.vim]:
117
+ Allows Erlang to be selected in the syntax menu. See also
118
+ ` runtime/synmenu.vim` .
119
+
120
+ * [` runtime/scripts.vim` ][vim-src/runtime/scripts.vim]:
121
+ Sets the file type to ` erlang` if the first line of the file matches
122
+ ` ^# ! [...]escript` . (It is not trivial what is accepted in the ` [...]`
123
+ part.)
124
+
125
+ * [` runtime/synmenu.vim` ][vim-src/runtime/synmenu.vim]:
126
+ Allows Erlang to be selected in the syntax menu. See also
127
+ ` runtime/makemenu.vim` .
128
+
129
+ * [` runtime/syntax/erlang.vim` ][vim-src/runtime/syntax/erlang.vim]:
130
+ Same as ` syntax/erlang.vim` in this repository.
131
+
132
+ * [` src/testdir/test_filetype.vim` ][vim-src/src/testdir/test_filetype.vim]:
133
+ An automatic test for setting file types.
134
+
135
+ # ## Development and testing the indentation script
91
136
92
137
This section is relevant only if you want to be involved in the development of
93
138
the indentation script.
@@ -115,7 +160,7 @@ Note: When the indentation scripts detects a syntax error in test mode (i.e.
115
160
when it was loaded with ` F1` from ` helper.vim` ), it indents the line to column
116
161
40 instead of leaving it as it is. This behavior is useful for testing.
117
162
118
- # # Running vader tests
163
+ # ## Running vader tests
119
164
120
165
The tests for the `include` and `define` options in ` test_include_search.vader`
121
166
are run using the [vader][vader] Vim plugin.
@@ -178,3 +223,13 @@ For more details, see the [vader][vader] repository.
178
223
179
224
[vader]: https://github.com/junegunn/vader.vim
180
225
[vim-plug]: https://github.com/junegunn/vim-plug
226
+ [vim-src/runtime/compiler/erlang.vim]: https://github.com/vim/vim/blob/master/runtime/compiler/erlang.vim
227
+ [vim-src/runtime/doc/syntax.txt]: https://github.com/vim/vim/blob/master/runtime/doc/syntax.txt
228
+ [vim-src/runtime/filetype.vim]: https://github.com/vim/vim/blob/master/runtime/filetype.vim
229
+ [vim-src/runtime/ftplugin/erlang.vim]: https://github.com/vim/vim/blob/master/runtime/ftplugin/erlang.vim
230
+ [vim-src/runtime/indent/erlang.vim]: https://github.com/vim/vim/blob/master/runtime/indent/erlang.vim
231
+ [vim-src/runtime/makemenu.vim]: https://github.com/vim/vim/blob/master/runtime/makemenu.vim
232
+ [vim-src/runtime/scripts.vim]: https://github.com/vim/vim/blob/master/runtime/scripts.vim
233
+ [vim-src/runtime/synmenu.vim]: https://github.com/vim/vim/blob/master/runtime/synmenu.vim
234
+ [vim-src/runtime/syntax/erlang.vim]: https://github.com/vim/vim/blob/master/runtime/syntax/erlang.vim
235
+ [vim-src/src/testdir/test_filetype.vim]: https://github.com/vim/vim/blob/master/src/testdir/test_filetype.vim
0 commit comments