Changeset 53944 in vbox for trunk/doc

Timestamp:

Jan 23, 2015 3:01:42 AM (10 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

97822

Message:

VBox-CodingGuidelines.cpp: Added a couple of lines about XSLT.

File:

• trunk/doc/VBox-CodingGuidelines.cpp (modified) (1 diff)

trunk/doc/VBox-CodingGuidelines.cpp

@@ -258 +258 @@
  * - All files like .cpp, .h, .ui, which belong together are located in the
  *   same directory and named the same
+ *
+ *
+ * @subsection sec_vbox_guideline_compulsory_xslt  XSLT
+ *
+ * XSLT (eXtensible Stylesheet Language Transformations) is used quite a bit in
+ * the Main API area of VirtualBox to generate sources and bindings to that API.
+ * There are a couple of common pitfalls worth mentioning:
+ *
+ *      - Never do repeated //interface[@name=...] and //enum[@name=...] lookups
+ *        because they are expensive. Instead delcare xsl:key elements for these
+ *        searches and do the lookup using the key() function. xsltproc uses
+ *        (per current document) hash tables for each xsl:key, i.e. very fast.
+ *
+ *      - When output type is 'text' make sure to call xsltprocNewlineOutputHack
+ *        from typemap-shared.inc.xsl every few KB of output, or xsltproc will
+ *        end up wasting all the time reallocating the output buffer.
  *
  *