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.

diff --git a/doc/snippet-organization.org b/doc/snippet-organization.org
index abe62adca58bf2dbe93af0b76bde292ed534bc54..68ee059b9d1c5aab0a49da28f7c4c86ac7c42c42 100644 (file)
--- 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