[med-svn] [opensurgsim] 01/02: Backport commit from upstream to use local mathjax

[Paul Novotny]

This is an automated email from the git hooks/post-receive script.

paulnovo-guest pushed a commit to branch master
in repository opensurgsim.

commit 173d995457911415aa51f69adb4e198186a1d3ee
Author: Paul Novotny <paul at paulnovo.us>
Date:   Tue Feb 24 21:21:06 2015 -0500

    Backport commit from upstream to use local mathjax
    
    Doxygen was using an online version of mathjax in the generated html
    documents. Lintian gave a warning about this, luckily upstream has
    added the ability to use a localy installed mathjax. This commit adds
    a patch to cherry-pick this commit.
---
 debian/patches/backport-cb568a34f.patch | 119 ++++++++++++++++++++++++++++++++
 debian/patches/series                   |   1 +
 2 files changed, 120 insertions(+)

diff --git a/debian/patches/backport-cb568a34f.patch b/debian/patches/backport-cb568a34f.patch
new file mode 100644
index 0000000..f530e63
--- /dev/null
+++ b/debian/patches/backport-cb568a34f.patch
@@ -0,0 +1,119 @@
+Description: Use libjs-mathjax for Doxygen documentation
+ Cherry-picked a commit from upstream that looks if mathjax is installed
+ locally before using the online version in the html doxygen documentation.
+ This fixes the "privacy-breach-may-use-debian-package" lintian error.
+Author: Paul Novotny <paul at paulnovo.us>
+Origin: upstream, https://github.com/simquest/opensurgsim/commit/cb568a34f
+Last-Update: 2015-02-24
+
+--- a/Documentation/CMakeLists.txt
++++ b/Documentation/CMakeLists.txt
+@@ -28,22 +28,11 @@
+ 
+ find_package(Doxygen REQUIRED)
+ 
+-if(EXISTS "${SURGSIM_THIRD_PARTY_DIR}/mathjax")
+-	set(MATHJAX_LOCAL "${SURGSIM_THIRD_PARTY_DIR}/mathjax")
+-else()
+-	set(MATHJAX_LOCAL "")
+-endif()
+-
+ set(SURGSIM_DOCUMENTATION_EXCLUDE_LIST
+ 	*/UnitTests/*
+ 	CACHE STRING "Directories and files to ignore when generating documentation")
+ mark_as_advanced(SURGSIM_DOCUMENTATION_EXCLUDE_LIST)
+ 
+-set(SURGSIM_DOCUMENTATION_MATHJAX_LOCAL
+-	"${MATHJAX_LOCAL}"
+-	CACHE PATH "A local copy of MathJax to be used for HTML documentation")
+-mark_as_advanced(SURGSIM_DOCUMENTATION_LOCAL_MATHJAX)
+-
+ set(PROJECT_LOGO "${CMAKE_CURRENT_SOURCE_DIR}/OpenSurgSim-dox.png")
+ set(HTML_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/header.html")
+ set(HTML_FOOTER "${CMAKE_CURRENT_SOURCE_DIR}/footer.html")
+@@ -66,20 +55,13 @@
+ 	set(WARN_FORMAT "\"$file:$line: $text\"")
+ endif(MSVC)
+ 
+-if(SURGSIM_DOCUMENTATION_MATHJAX_LOCAL STREQUAL "")
+-	# Use MathJax directly from the web
+-	set(MATHJAX_RELPATH http://www.mathjax.org/mathjax)
++find_package(MathJax)
++if(MATHJAX_FOUND)
++	set(MATHJAX_RELPATH ${MATHJAX_DIR})
++	message(STATUS "Using local MathJax:" ${MATHJAX_DIR})
+ else()
+-	# Copy MathJax directly into the generated documentation
+-	if(NOT EXISTS "${CMAKE_CURRENT_BINARY_DIR}/html/mathjax")
+-		message("Copying local MathJax (please be patient)...")
+-		file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html/")
+-		file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html/mathjax/")
+-		file(COPY "${SURGSIM_THIRD_PARTY_DIR}/mathjax/."
+-			DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/html/")
+-		message("...done!")
+-	endif()
+-	set(MATHJAX_RELPATH ./mathjax)
++	set(MATHJAX_RELPATH "http://cdn.mathjax.org/mathjax/latest")
++	message(STATUS "Using web-based MathJax: " ${MATHJAX_RELPATH})
+ endif()
+ 
+ # Generate Doxyfile from Doxyfile.in, with @VARIABLE@ substitution.
+--- a/README
++++ b/README
+@@ -45,8 +45,8 @@
+ system for the dependencies (see Appendix). For Debian/Ubuntu based systems, the
+ dependencies are easily installed through apt-get:
+ 
+-    sudo apt-get install libboost-all-dev cmake doxygen
+-    sudo apt-get install libeigen3-dev google-mock libopenscenegraph-dev
++    sudo apt-get install libboost-all-dev cmake doxygen libeigen3-dev
++    sudo apt-get install google-mock libjs-mathjax libopenscenegraph-dev
+ 
+ To build OpenSurgSim, issue the following commands from the same directory used
+ to obtain OpenSurgSim (see Section 1)
+@@ -141,3 +141,7 @@
+   Homepage: https://code.google.com/p/googlemock/  
+   Minimum Version: 1.7.0  
+ 
++* MathJax  
++  Homepage: http://www.mathjax.org/  
++  Minimum Version: 2.4
++
+--- /dev/null
++++ b/CMake/FindMathJax.cmake
+@@ -0,0 +1,35 @@
++# This file is a part of the OpenSurgSim project.
++# Copyright 2014, SimQuest Solutions Inc.
++#
++# Licensed under the Apache License, Version 2.0 (the "License");
++# you may not use this file except in compliance with the License.
++# You may obtain a copy of the License at
++#
++#     http://www.apache.org/licenses/LICENSE-2.0
++#
++# Unless required by applicable law or agreed to in writing, software
++# distributed under the License is distributed on an "AS IS" BASIS,
++# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
++# See the License for the specific language governing permissions and
++# limitations under the License.
++
++
++# - Try to find MathJax
++#
++# Once done this will define
++#  MATHJAX_FOUND
++#  MATHJAX_DIR
++#
++
++if(NOT MATHJAX_DIR)
++	find_path(MATHJAX_DIR
++		NAMES MathJax.js
++		PATHS "$ENV{MATHJAX_DIR}" "/usr/share/javascript/mathjax/"
++		DOC "Path to local MathJax.js"
++	)
++endif()
++
++include(FindPackageHandleStandardArgs)
++find_package_handle_standard_args(MathJax DEFAULT_MSG MATHJAX_DIR)
++
++mark_as_advanced(MATHJAX_DIR)
diff --git a/debian/patches/series b/debian/patches/series
index f6c040a..fd9ff98 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,3 +1,4 @@
 backport-03c10f32d.patch
 use-debian-yaml-cpp.patch
 add-version-to-libs.patch
+backport-cb568a34f.patch

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/opensurgsim.git