From 7e7153457722ff2272bf094cca5387bd2e2ebd71 Mon Sep 17 00:00:00 2001 From: "arseny.kapoulkine@gmail.com" Date: Sun, 29 Apr 2012 22:51:21 +0000 Subject: docs: Regenerated HTML documentation git-svn-id: http://pugixml.googlecode.com/svn/trunk@908 99668b35-9821-0410-8761-19e4c4f06640 --- docs/manual/install.html | 88 ++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 78 insertions(+), 10 deletions(-) (limited to 'docs/manual/install.html') diff --git a/docs/manual/install.html b/docs/manual/install.html index 9809a39..df7b322 100644 --- a/docs/manual/install.html +++ b/docs/manual/install.html @@ -4,15 +4,15 @@ Installation - - - + + +
-pugixml 1.0 manual | +pugixml 1.2 manual | Overview | Installation | Document: @@ -44,6 +44,8 @@ a standalone static library
Building pugixml as a standalone shared library
+
Using pugixml in header-only + mode
Additional configuration options
@@ -65,8 +67,8 @@ You can download the latest source distribution via one of the following links:

-
http://pugixml.googlecode.com/files/pugixml-1.0.zip
-http://pugixml.googlecode.com/files/pugixml-1.0.tar.gz
+
http://pugixml.googlecode.com/files/pugixml-1.2.zip
+http://pugixml.googlecode.com/files/pugixml-1.2.tar.gz
 

The distribution contains library source, documentation (the manual you're @@ -94,7 +96,7 @@

For example, to checkout the current version, you can use this command:

-
svn checkout http://pugixml.googlecode.com/svn/tags/release-1.0 pugixml
+
svn checkout http://pugixml.googlecode.com/svn/tags/release-1.2 pugixml

To checkout the latest version, you can use this command:

@@ -269,6 +271,58 @@

+
+ +

+ It's possible to use pugixml in header-only mode. This means that all source + code for pugixml will be included in every translation unit that includes + pugixml.hpp. This is how most of Boost and STL libraries work. +

+

+ Note that there are advantages and drawbacks of this approach. Header mode + may improve tree traversal/modification performance (because many simple + functions will be inlined), if your compiler toolchain does not support + link-time optimization, or if you have it turned off (with link-time optimization + the performance should be similar to non-header mode). However, since compiler + now has to compile pugixml source once for each translation unit that includes + it, compilation times may increase noticeably. If you want to use pugixml + in header mode but do not need XPath support, you can consider disabling + it by using PUGIXML_NO_XPATH define + to improve compilation time. +

+

+ Enabling header-only mode is a two-step process: +

+
    +
  1. + You have to define PUGIXML_HEADER_ONLY +
  2. +
  3. + You have to include pugixml.cpp whenever you include pugixml.hpp +
  4. +
+

+ Both of these are best done via pugiconfig.hpp like this: +

+
#define PUGIXML_HEADER_ONLY
+#include "pugixml.cpp"
+
+

+ Note that it is safe to compile pugixml.cpp if PUGIXML_HEADER_ONLY + is defined - so if you want to i.e. use header-only mode only in Release + configuration, you can include pugixml.cpp in your project (see Building pugixml as + a part of another static library/executable), + and conditionally enable header-only mode in pugiconfig.hpp, i.e.: +

+
#ifndef _DEBUG
+    #define PUGIXML_HEADER_ONLY
+    #include "pugixml.cpp"
+#endif
+
+

Additional configuration @@ -337,6 +391,12 @@ the consistency rule.

+

+ PUGIXML_MEMORY_PAGE_SIZE, PUGIXML_MEMORY_OUTPUT_STACK + and PUGIXML_MEMORY_XPATH_PAGE_SIZE + can be used to customize certain important sizes to optimize memory usage + for the application-specific patterns. For details see Memory consumption tuning. +

@@ -367,7 +427,8 @@
  • Microsoft Visual C++ 6.0, 7.0 (2002), 7.1 (2003), 8.0 (2005) x86/x64, - 9.0 (2008) x86/x64, 10.0 (2010) x86/x64 + 9.0 (2008) x86/x64, 10.0 (2010) x86/x64, 11.0 x86/x64/ARM and some + CLR versions
  • MinGW (GCC) 3.4, 4.4, 4.5, 4.6 x64 @@ -383,6 +444,9 @@
  • Apple MacOSX (GCC 4.0.1 x86/x64/PowerPC)
  • +
  • + Sun Solaris (sunCC x86/x64) +
  • Microsoft Xbox 360
  • @@ -395,6 +459,10 @@
  • Sony Playstation 3 (GCC 4.1.1, SNC 310.1)
  • +
  • + Various portable platforms (Android NDK, BlackBerry NDK, Samsung bada, + Windows CE) +
  • @@ -405,7 +473,7 @@
    - @@ -413,7 +481,7 @@
    -pugixml 1.0 manual | +pugixml 1.2 manual | Overview | Installation | Document: -- cgit v1.2.3