Browse Source

documentation of *org-babel-use-quick-and-dirty-noweb-expansion*

* doc/org.texi (Noweb reference syntax): Adding documentation of
  the *org-babel-use-quick-and-dirty-noweb-expansion* variable.
Eric Schulte 13 years ago
parent
commit
926a24aab5
1 changed files with 8 additions and 1 deletions
  1. 8 1
      doc/org.texi

+ 8 - 1
doc/org.texi

@@ -13991,7 +13991,8 @@ When a code block is tangled or evaluated, whether or not ``noweb''
 references are expanded depends upon the value of the @code{:noweb} header
 references are expanded depends upon the value of the @code{:noweb} header
 argument.  If @code{:noweb yes}, then a Noweb reference is expanded before
 argument.  If @code{:noweb yes}, then a Noweb reference is expanded before
 evaluation.  If @code{:noweb no}, the default, then the reference is not
 evaluation.  If @code{:noweb no}, the default, then the reference is not
-expanded before evaluation.
+expanded before evaluation.  See the @ref{noweb-ref} header argument for
+a more flexible way to resolve noweb references.
 
 
 Note: the default value, @code{:noweb no}, was chosen to ensure that
 Note: the default value, @code{:noweb no}, was chosen to ensure that
 correct code is not broken in a language, such as Ruby, where
 correct code is not broken in a language, such as Ruby, where
@@ -13999,6 +14000,12 @@ correct code is not broken in a language, such as Ruby, where
 syntactically valid in languages that you use, then please consider setting
 syntactically valid in languages that you use, then please consider setting
 the default value.
 the default value.
 
 
+Note: if noweb tangling is slow in large Org-mode files consider setting the
+@code{*org-babel-use-quick-and-dirty-noweb-expansion*} variable to true.
+This will result in faster noweb reference resolution at the expense of not
+correctly resolving inherited values of the @code{:noweb-ref} header
+argument.
+
 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
 @section Key bindings and useful functions
 @section Key bindings and useful functions
 @cindex code block, key bindings
 @cindex code block, key bindings