Merge pull request #237 from arvidn/travis-docs

make travis build documentation

.travis.yml

@@ -5,7 +5,7 @@ os:
   - osx
 
 env:
-  - variant=test_release lang=cpp11 sim=0 coverage=1
+  - variant=test_release lang=cpp11 sim=0 coverage=1 docs=1
   - variant=test_debug lang=cpp11 sim=1 coverage=0
   - variant=test_debug lang=cpp98 sim=0 coverage=0
   - variant=test_barebones lang=cpp11 sim=0 coverage=0
@@ -36,6 +36,8 @@ addons:
     - libboost1.55-tools-dev
     - python2.7-dev
     - g++-4.8
+    - python3-docutils
+    - python3-pygments
 
 before_install:
   - git submodule update --init --recursive
@@ -66,8 +68,14 @@ install:
   - 'echo "using darwin : cpp98 : ccache clang++ : <cflags>-std=c99 <cxxflags>-std=c++98 <compileflags>-Wno-deprecated-declarations ;" >> ~/user-config.jam'
   - 'echo "using python : 2.7 ;" >> ~/user-config.jam'
   - ccache -V && ccache --show-stats && ccache --zero-stats
+  - if [[ $docs == "1" && $TRAVIS_OS_NAME == "linux" ]]; then rst2html --version; fi
 
 script:
+# disable invoking docutils for now, until we can have a modern version of it
+  - cd docs
+  - if [[ $docs == "1" && $TRAVIS_OS_NAME == "linux" ]]; then make rst RST2HTML=rst2html; fi
+  - cd ..
+
   - cd test
   - bjam --hash -j3 warnings-as-errors=on variant=$variant -l900 $coverage_toolset $target
 # if we're building with code coverage, report it as soon as possible
@@ -90,10 +98,10 @@ script:
   - LD_LIBRARY_PATH=../../lib DYLD_LIBRARY_PATH=../../lib python test.py
   - cd ../..
 
+  - cd simulation
   - if [ $sim = "1" ]; then
-    cd simulation;
     bjam --hash -j2 crypto=built-in $coverage_toolset;
-    cd ..;
     fi
+  - cd ..
   - ccache --show-stats
 

docs/gen_stats_doc.py

@@ -7,9 +7,12 @@ f = open('../include/libtorrent/performance_counters.hpp')
 counter_type = ''
 
 for l in f:
+
+	# ignore anything after //
+	if '//' in l: l = l.split('//')[0]
+
 	l = l.strip()
 
-	if l.startswith('//'): continue
 	if l.startswith('#'): continue
 	if l == '': continue
 

docs/makefile

@@ -55,6 +55,8 @@ FIGURES = \
 	disk_cache \
 	troubleshooting
 
+rst: $(TARGETS:=.rst) todo.html
+
 html: $(TARGETS:=.html) $(FIGURES:=.png) todo.html
 
 pdf: $(TARGETS:=.pdf) $(FIGURES:=.eps)

docs/settings.rst

@@ -1952,6 +1952,9 @@ usage. It defaults to 0. ``cache_expiry`` is the number of seconds
 from the last cached write to a piece in the write cache, to when
 it's forcefully flushed to disk. Default is 60 second.
 
+On 32 bit builds, the effective cache size will be limited to 3/4 of
+2 GiB to avoid exceeding the virtual address space limit.
+
 .. _explicit_cache_interval:
 
 .. raw:: html