diff options
author | Zhiming Wang <zmwangx@gmail.com> | 2015-08-04 14:39:36 -0700 |
---|---|---|
committer | Zhiming Wang <zmwangx@gmail.com> | 2015-08-04 14:48:14 -0700 |
commit | 0ada0fc9445cab7405eb7bedacf0e82b0fc81e11 (patch) | |
tree | 596b0472b96adc50cde749e9b58b2609ed7eb14c | |
parent | c91a58840b86ae92061a003ec07db1010fde6c90 (diff) |
Add documentation for snippet compilation
Specifically, fill in the section about .yas-compiled-snippet.el, which
was previously labelled as TODO.
* doc/snippet-organization.org (The =.yas-compiled-snippet.el= file):
Fill in section.
-rw-r--r-- | doc/snippet-organization.org | 21 |
1 files changed, 18 insertions, 3 deletions
diff --git a/doc/snippet-organization.org b/doc/snippet-organization.org index abe62ad..68ee059 100644 --- a/doc/snippet-organization.org +++ b/doc/snippet-organization.org @@ -112,9 +112,24 @@ ** TODO -* TODO The =.yas-compiled-snippet.el= file - -** TODO +* The =.yas-compiled-snippet.el= file + + You may compile a top-level snippet directory with the + =yas-compile-directory= function, which will create a + =.yas-compiled-snippets.el= file under each mode subdirectory, + which contains definitions for all snippets in the subdirectory. + Compilation helps improve loading time. + + Alternatively, you may compile all directories in the list + =yas-snippet-dirs= with the =yas-recompile-all= function. + + *Caveat.* At the moment, when you try to use the + =yas-visit-snippet-file= function to edit a compiled snippet loaded + from a =.yas-compiled-snippets.el= file, the content of the snippet + will be opened in a buffer, but it might not be a verbatim copy of + your original snippet, and =yas-load-snippet-buffer-and-close= + won't offer to save to the original snippet file. See + [[https://github.com/capitaomorte/yasnippet/issues/597][#597]]. * TODO The =.yas-skip= file |