Repository: incubator-gearpump Updated Branches: refs/heads/master ccf318f3a -> e970d8b54
GEARPUMP-36: fix doc build on Mac OSX 10.11 Project: http://git-wip-us.apache.org/repos/asf/incubator-gearpump/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-gearpump/commit/e970d8b5 Tree: http://git-wip-us.apache.org/repos/asf/incubator-gearpump/tree/e970d8b5 Diff: http://git-wip-us.apache.org/repos/asf/incubator-gearpump/diff/e970d8b5 Branch: refs/heads/master Commit: e970d8b54811ab4356222243d494dad3de7adf49 Parents: ccf318f Author: Weihua Jiang <[email protected]> Authored: Mon Apr 18 17:42:29 2016 +0800 Committer: manuzhang <[email protected]> Committed: Fri Apr 29 08:47:02 2016 +0800 ---------------------------------------------------------------------- docs/README.md | 20 ++++++++++++++++++++ docs/build_doc.sh | 17 +++++++++++++---- docs/gearpump-internals.md | 2 +- 3 files changed, 34 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/e970d8b5/docs/README.md ---------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index e0793ee..e820f45 100644 --- a/docs/README.md +++ b/docs/README.md @@ -26,9 +26,29 @@ ERROR: While executing gem ... (Errno::EPERM) Operation not permitted - /usr/bin/listen ``` +If you are using Mac OSX 10.11+ (El Capitan), you will need to execute following command: +``` +sudo gvim /Library/Ruby/Gems/2.0.0/gems/ffi-1.9.10/lib/ffi/library.rb +``` +And change following code in this file: +```ruby +module FFI +... + def self.map_library_name(lib) + ... + lib = Library::LIBC if lib == 'c' + lib = Library::LIBCURL if lib == 'libcurl' +... +module Library + CURRENT_PROCESS = FFI::CURRENT_PROCESS + LIBC = '/usr/lib/libc.dylib' + LIBCURL = '/usr/lib/libcurl.dylib' +``` + Kramdown is needed for Markdown processing and the Python based Pygments is used for syntax highlighting. + # How to Build Command `./build_doc.sh` can be used to create a full document folder under site/. http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/e970d8b5/docs/build_doc.sh ---------------------------------------------------------------------- diff --git a/docs/build_doc.sh b/docs/build_doc.sh index 72a2079..b033e8e 100755 --- a/docs/build_doc.sh +++ b/docs/build_doc.sh @@ -1,6 +1,7 @@ #!/bin/bash CURDIR=`pwd` CURDIRNAME=`basename $CURDIR` + if [ "$CURDIRNAME" != "docs" ]; then echo "This script MUST be run under 'docs' directory. " exit 1 @@ -33,11 +34,19 @@ export BUILD_API=$2 jekyll build # check html link validity -echo "Checking generated HTMLs..." -htmlproof _site \ +# htmlproof has been renamed to htmlproofer in Dec 2015 +HTMLPROOF="htmlproof" +HTML_IGNORE_HREF='--href-ignore "#/"' +if ! `which $HTMLPROOF >/dev/null`; then + HTMLPROOF="htmlproofer" + HTML_IGNORE_HREF="--allow-hash-href" +fi +echo "Checking generated HTMLs using $HTMLPROOF..." + +$HTMLPROOF _site \ --disable-external \ - --href-ignore "#/" \ - --url-ignore \#,api/scala/index.html,api/java/index.html + $HTML_IGNORE_HREF \ + --url-ignore \#,api/scala/index.html,api/java/index.html,/download.html # generate API doc if [ "$BUILD_API" = 1 ]; then http://git-wip-us.apache.org/repos/asf/incubator-gearpump/blob/e970d8b5/docs/gearpump-internals.md ---------------------------------------------------------------------- diff --git a/docs/gearpump-internals.md b/docs/gearpump-internals.md index 06e045d..8b189fa 100644 --- a/docs/gearpump-internals.md +++ b/docs/gearpump-internals.md @@ -119,7 +119,7 @@ In case of a master crash, other standby masters will be notified, they will res #### What happens when a worker crashes? -In case of a worker crash, the Master will get notified and stop scheduling new computation to this worker. All supervised executors on current worker will be killed, AppMaster can treat it as recovery of executor crash like [What happen when executor crash?](#what-happen-when-executor-crash) +In case of a worker crash, the Master will get notified and stop scheduling new computation to this worker. All supervised executors on current worker will be killed, AppMaster can treat it as recovery of executor crash like [What happen when executor crash?](#what-happen-when-an-executor-crashes) #### What happens when the AppMaster crashes?
