You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by ka...@apache.org on 2016/02/20 17:47:53 UTC
[4/4] mesos git commit: Updated Doxyfile to use relative path.
Updated Doxyfile to use relative path.
By default, doxygen generated html pages use absolute path for links
(due to FULL_PATH_NAMES flag set to 'yes'). Thus the links break when
these pages are moved to a different directory. The fix is to ask
doxygen to strip out '/path/to/mesos/' from the generated links.
Review: https://reviews.apache.org/r/43382
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/af14c386
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/af14c386
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/af14c386
Branch: refs/heads/master
Commit: af14c3862f7f4167764452d0c41246b49022e8b2
Parents: 1488f16
Author: Kapil Arya <ka...@mesosphere.io>
Authored: Tue Feb 9 16:04:59 2016 -0500
Committer: Kapil Arya <ka...@mesosphere.io>
Committed: Sat Feb 20 11:46:55 2016 -0500
----------------------------------------------------------------------
Doxyfile | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/af14c386/Doxyfile
----------------------------------------------------------------------
diff --git a/Doxyfile b/Doxyfile
index 1b0a2be..d6dcb6b 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -114,7 +114,13 @@ FULL_PATH_NAMES = YES
# If left blank the directory from which doxygen is run is used as the
# path to strip.
-STRIP_FROM_PATH =
+# Since we are setting FULL_PATH_NAMES, we should strip out '/path/to/mesos/'.
+# Otherwise, the html links also contain '/path/to/mesos/' and aren't relative.
+# We use '../' here because this file is invoked from within the 'site/'
+# directory as `doxygen -f ../Doxyfile` and thus the value '../' is equivalent
+# to specifying '/path/to/mesos/'.
+
+STRIP_FROM_PATH = ../
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells