scripts/docs in rvm-1.0.7 vs scripts/docs in rvm-1.0.8

- old
+ new

@@ -1,20 +1,27 @@ #!/usr/bin/env bash rvm_base_except="selector" + source "$rvm_path/scripts/base" rvm_docs_ruby_string="$(__rvm_environment_identifier | awk -F"${rvm_gemset_separator:-"@"}" '{print $1}')" + if [[ "$rvm_docs_ruby_string" = "system" || -z "$rvm_docs_ruby_string" ]]; then + "$rvm_path/scripts/log" "error" "Currently 'rvm docs ...' does not work with non-rvm rubies." + exit 1 + fi rvm_docs_type="${rvm_docs_type:-rdoc}" # Ensure we have the doc directories. -if [[ ! -d "$rvm_docs_path" ]] ; then - \mkdir -p "$rvm_docs_path/rdoc" "$rvm_docs_path/yard" +if [[ ! -d "${rvm_docs_path:-"$rvm_path/docs"}" ]] ; then + + mkdir -p "${rvm_docs_path:-"$rvm_path/docs"}/rdoc" "${rvm_docs_path:-"$rvm_path/docs"}/yard" + fi usage() { printf " @@ -25,42 +32,63 @@ " return 0 } open_docs() { - if [[ -s "$rvm_docs_path/$rvm_docs_ruby_string/$rvm_docs_type/index.html" ]] ; then + if [[ -s "${rvm_docs_path:-"$rvm_path/docs"}/$rvm_docs_ruby_string/$rvm_docs_type/index.html" ]] ; then + if command -v open >/dev/null ; then - open "$rvm_docs_path/$rvm_docs_ruby_string/$rvm_docs_type/index.html" + + open "${rvm_docs_path:-"$rvm_path/docs"}/$rvm_docs_ruby_string/$rvm_docs_type/index.html" + elif command -v xdg-open >/dev/null ; then - xdg-open "$rvm_docs_path/$rvm_docs_ruby_string/$rvm_docs_type/index.html" + + xdg-open "${rvm_docs_path:-"$rvm_path/docs"}/$rvm_docs_ruby_string/$rvm_docs_type/index.html" + else + "$rvm_path/scripts"/log "error" "Neither open nor xdg-open were found, in order to open the docs one of these two are required. \n(OR you can let me know how else to open the html in your browser from comand line on your OS :) )" + fi + else + "$rvm_path/scripts"/log "error" "$rvm_docs_type docs are missing, perhaps run 'rvm docs generate' first?" + fi } generate_ri() { # Generate ri docs ( - builtin cd "$rvm_src_path/$rvm_docs_ruby_string/" + builtin cd "${rvm_src_path:-"$rvm_path/src"}/$rvm_docs_ruby_string/" + "$rvm_path/scripts/log" "info" "Generating ri documentation, be aware that this could take a *long* time, and depends heavily on your system resources..." - "$rvm_path/scripts/log" "info" "( Errors will be logged to $rvm_log_path/$rvm_docs_ruby_string/docs.error.log )" - rdoc -a --ri --ri-site > /dev/null 2>> $rvm_log_path/$rvm_docs_ruby_string/docs.error.log + + "$rvm_path/scripts/log" "info" "( Errors will be logged to ${rvm_log_path:-"$rvm_path/log"}/$rvm_docs_ruby_string/docs.error.log )" + + rdoc -a --ri --ri-site > /dev/null 2>> ${rvm_log_path:-"$rvm_path/log"}/$rvm_docs_ruby_string/docs.error.log ) } generate_rdoc() { ( - builtin cd "$rvm_src_path/$rvm_docs_ruby_string/" - \rm -rf "$rvm_docs_path/$rvm_docs_ruby_string/$rvm_docs_type/" + builtin cd "${rvm_src_path:-"$rvm_path/src"}/$rvm_docs_ruby_string/" + + \rm -rf "${rvm_docs_path:-"$rvm_path/docs"}/$rvm_docs_ruby_string/$rvm_docs_type/" + "$rvm_path/scripts/log" "info" "Generating rdoc documentation, be aware that this could take a *long* time, and depends heavily on your system resources..." - "$rvm_path/scripts/log" "info" "( Errors will be logged to $rvm_log_path/$rvm_docs_ruby_string/docs.error.log )" + + "$rvm_path/scripts/log" "info" "( Errors will be logged to ${rvm_log_path:-"$rvm_path/log"}/$rvm_docs_ruby_string/docs.error.log )" + if gem list | \grep -q ^hanna ; then - hanna -o "$rvm_docs_path/$rvm_docs_ruby_string/$rvm_docs_type" --inline-source --line-numbers --fmt=html > /dev/null 2>> "$rvm_log_path/$rvm_docs_ruby_string/docs.error.log" + + hanna -o "${rvm_docs_path:-"$rvm_path/docs"}/$rvm_docs_ruby_string/$rvm_docs_type" --inline-source --line-numbers --fmt=html > /dev/null 2>> "${rvm_log_path:-"$rvm_path/log"}/$rvm_docs_ruby_string/docs.error.log" + else - rdoc -a -o "$rvm_docs_path/$rvm_docs_ruby_string/$rvm_docs_type" > /dev/null 2>> "$rvm_log_path/$rvm_docs_ruby_string/docs.error.log" + + rdoc -a -o "${rvm_docs_path:-"$rvm_path/docs"}/$rvm_docs_ruby_string/$rvm_docs_type" > /dev/null 2>> "${rvm_log_path:-"$rvm_path/log"}/$rvm_docs_ruby_string/docs.error.log" + fi ) } args=($*)