From 1a06d7d3de3d2f30eaf3d56b7b2d0fa3446d46d8 Mon Sep 17 00:00:00 2001 From: Arseny Kapoulkine Date: Tue, 18 Nov 2014 09:30:19 -0800 Subject: docs: Regenerated documentation Also fix documentation jam rules for Windows. --- docs/manual/install.html | 118 +++++++++++++++++++++++------------------------ 1 file changed, 58 insertions(+), 60 deletions(-) (limited to 'docs/manual/install.html') diff --git a/docs/manual/install.html b/docs/manual/install.html index 5675651..af662c1 100644 --- a/docs/manual/install.html +++ b/docs/manual/install.html @@ -4,15 +4,15 @@ Installation - - - + + +
-pugixml 1.4 manual | +pugixml 1.5 manual | Overview | Installation | Document: @@ -28,48 +28,48 @@

pugixml is distributed in source form. You can either download a source distribution - or checkout the Subversion repository. + or clone the Git repository.

You can download the latest source distribution via one of the following links:

-
https://github.com/zeux/pugixml/releases/download/v1.4/pugixml-1.4.zip
-https://github.com/zeux/pugixml/releases/download/v1.4/pugixml-1.4.tar.gz
+
https://github.com/zeux/pugixml/releases/download/v1.5/pugixml-1.5.zip
+https://github.com/zeux/pugixml/releases/download/v1.5/pugixml-1.5.tar.gz
 

The distribution contains library source, documentation (the manual you're @@ -80,56 +80,54 @@ line endings. Otherwise the files in both archives are identical.

- If you need an older version, you can download it from the version + If you need an older version, you can download it from the version archive.

- The Subversion repository is located at http://pugixml.googlecode.com/svn/. - There is a Subversion tag "release-{version}" for each version; - also there is the "latest" tag, which always points to the latest - stable release. + The Git repository is located at https://github.com/zeux/pugixml/. + There is a Git tag "v{version}" for each version; also there + is the "latest" tag, which always points to the latest stable + release.

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

-
svn checkout http://pugixml.googlecode.com/svn/tags/release-1.4 pugixml
-

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

-
svn checkout http://pugixml.googlecode.com/svn/tags/latest pugixml
+
git clone https://github.com/zeux/pugixml
+cd pugixml
+git checkout v1.5
+

The repository contains library source, documentation, code examples and full unit test suite.

- Use latest version tag if you want to automatically get new versions via - svn update. Use other tags if you want to switch to - new versions only explicitly (for example, using svn switch - command). Also please note that Subversion trunk contains the work-in-progress - version of the code; while this means that you can get new features and - bug fixes from trunk without waiting for a new release, this also means - that occasionally the code can be broken in some configurations. + Use latest version tag if you want to automatically get new versions. Use + other tags if you want to switch to new versions only explicitly. Also + please note that the master branch contains the work-in-progress version + of the code; while this means that you can get new features and bug fixes + from master without waiting for a new release, this also means that occasionally + the code can be broken in some configurations.

- The Subversion repository is mirrored by a Git repository at https://github.com/zeux/pugixml. - The mirror is frequently updated and has the same structure in terms of - tags and contents as Subversion repository. + You can access the Git repository via Subversion using https://github.com/zeux/pugixml + URL. For example, to checkout the current version, you can use this command:

+
svn checkout https://github.com/zeux/pugixml/tags/v1.5 pugixml

pugixml is distributed in source form without any pre-built binaries; you @@ -139,7 +137,7 @@ The complete pugixml source consists of three files - one source file, pugixml.cpp, and two header files, pugixml.hpp and pugiconfig.hpp. pugixml.hpp is the primary header which you need to include in order to use pugixml classes/functions; - pugiconfig.hpp is a supplementary configuration file (see Additional configuration + pugiconfig.hpp is a supplementary configuration file (see Additional configuration options). The rest of this guide assumes that pugixml.hpp is either in the current directory or in one of include directories of your projects, so that #include "pugixml.hpp" @@ -149,7 +147,7 @@

@@ -194,7 +192,7 @@ are project files for Apple XCode3, Code::Blocks, Codelite, Microsoft Visual Studio 2005, 2008, 2010, and configuration scripts for CMake and premake4. You're welcome to submit project files/build scripts for other software; - see Feedback. + see Feedback.

There are two projects for each version of Microsoft Visual Studio: one @@ -247,7 +245,7 @@

-
+

It's possible to use pugixml in header-only mode. This means that all source @@ -324,7 +322,7 @@

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 + 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.:

@@ -336,7 +334,7 @@

@@ -358,7 +356,7 @@ as character type) and UTF-16/32 style interface (the in-memory text encoding is assumed to be UTF-16/32, depending on wchar_t size, most functions use wchar_t - as character type). See Unicode interface for more details. + as character type). See Unicode interface for more details.

PUGIXML_NO_XPATH define disables XPath. @@ -388,7 +386,7 @@ is used instead. For example, to specify fixed calling convention, you can define PUGIXML_FUNCTION to i.e. __fastcall. Another - example is DLL import/export attributes in MSVC (see Building pugixml as + example is DLL import/export attributes in MSVC (see Building pugixml as a standalone shared library).

@@ -406,7 +404,7 @@ 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. + for the application-specific patterns. For details see Memory consumption tuning.

PUGIXML_HAS_LONG_LONG define enables @@ -422,7 +420,7 @@

pugixml is written in standard-compliant C++ with some compiler-specific @@ -502,7 +500,7 @@


-pugixml 1.4 manual | +pugixml 1.5 manual | Overview | Installation | Document: -- cgit v1.2.3