[Boost-commit] svn:boost r85428 - trunk/tools/quickbook/doc

Subject: [Boost-commit] svn:boost r85428 - trunk/tools/quickbook/doc
From: dnljms_at_[hidden]
Date: 2013-08-22 16:49:05

Author: danieljames
Date: 2013-08-22 16:49:05 EDT (Thu, 22 Aug 2013)
New Revision: 85428
URL: http://svn.boost.org/trac/boost/changeset/85428

Log:
Add a quick guide on upgrading to 1.6

Text files modified: 
   trunk/tools/quickbook/doc/1_6.qbk |    28 +++++++++++++++++++++++++++-            
   1 files changed, 27 insertions(+), 1 deletions(-)

Modified: trunk/tools/quickbook/doc/1_6.qbk
==============================================================================
--- trunk/tools/quickbook/doc/1_6.qbk	Thu Aug 22 15:50:55 2013	(r85427)
+++ trunk/tools/quickbook/doc/1_6.qbk	2013-08-22 16:49:05 EDT (Thu, 22 Aug 2013)	(r85428)
@@ -9,7 +9,33 @@
 
 [section:1_6 Quickbook 1.6]
 
-Everything described in here may change depending on the feedback received.
+Upgrading a document from an earlier version of quickbook shouldn't be too
+hard. The first thing to do is update the version in the docinfo block.
+For example, if you were updating the Xpressive documentation, the existing
+docinfo block looks like:
+
+    [library Boost.Xpressive
+        [quickbook 1.3]
+        ...
+    ]
+
+Change this to:
+
+    [library Boost.Xpressive
+        [quickbook 1.6]
+        [compatibility-mode 1.3]
+        ...
+    ]
+
+The =compatibility-mode= tag ensures that automatically generated links
+won't change. It might turn out that it isn't required, but in Xpressive's
+case if it isn't included it will break a lot of links.
+
+Then try building it. You might need to fix some stray square brackets. The
+new version has a stricter parser which will have an error for brackets
+which don't pair up. They might be there by mistake, in which case they
+should probably be deleted, or if they're intentional escaped. For example,
+to write out the half-open range \[a,b), use: `\[a,b)`.
 
 [section:docinfo Includes with docinfo]