From: Ned Deily <nad@acm.org>
Date: Mon, 7 Feb 2011 16:52:25 +0000 (+0000)
Subject: Issue #11079: The /Applications/Python x.x folder created by the Mac
X-Git-Tag: v2.7.2rc1~331
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=68adfdcd842317a4d663416a8821a042cd088757;p=python

Issue #11079: The /Applications/Python x.x folder created by the Mac
OS X installers now includes a link to the installed documentation.
---

diff --git a/Mac/BuildScript/scripts/postflight.documentation b/Mac/BuildScript/scripts/postflight.documentation
index 9f5918ed78..30d2ee527b 100755
--- a/Mac/BuildScript/scripts/postflight.documentation
+++ b/Mac/BuildScript/scripts/postflight.documentation
@@ -1,11 +1,32 @@
 #!/bin/sh
 
 PYVER="@PYVER@"
+FWK="/Library/Frameworks/Python.framework/Versions/${PYVER}"
+FWK_DOCDIR_SUBPATH="Resources/English.lproj/Documentation"
+FWK_DOCDIR="${FWK}/${FWK_DOCDIR_SUBPATH}"
+APPDIR="/Applications/Python ${PYVER}"
+DEV_DOCDIR="/Developer/Documentation"
+SHARE_DIR="${FWK}/share"
+SHARE_DOCDIR="${SHARE_DIR}/doc/python${PYVER}"
+SHARE_DOCDIR_TO_FWK="../../.."
 
-if [ -d /Developer/Documentation ]; then
-	if [ ! -d /Developer/Documentation/Python ]; then
-		mkdir -p /Developer/Documentation/Python
-	fi
+# make link in /Developer/Documentation/ for Xcode users
+if [ -d "${DEV_DOCDIR}" ]; then
+    if [ ! -d "${DEV_DOCDIR}/Python" ]; then
+        mkdir -p "${DEV_DOCDIR}/Python"
+    fi
+    ln -fhs "${FWK_DOCDIR}" "${DEV_DOCDIR}/Python/Reference Documentation ${PYVER}"
+fi
+
+# make link in /Applications/Python m.n/ for Finder users
+if [ -d "${APPDIR}" ]; then
+    ln -fhs "${FWK_DOCDIR}/index.html" "${APPDIR}/Python Documentation.html"
+fi
 
-	ln -fhs /Library/Frameworks/Python.framework/Versions/${PYVER}/Resources/English.lproj/Documentation "/Developer/Documentation/Python/Reference Documentation @PYVER@"
+# make share/doc link in framework for command line users
+if [ -d "${SHARE_DIR}" ]; then
+    mkdir -p "${SHARE_DOCDIR}"
+    # make relative link to html doc directory
+    ln -s "${SHARE_DOCDIR_TO_FWK}/${FWK_DOCDIR_SUBPATH}" "${SHARE_DOCDIR}/html"
 fi
+
diff --git a/Misc/NEWS b/Misc/NEWS
index 0808f071d2..15f7f254ea 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -167,6 +167,9 @@ Extension Modules
 Build
 -----
 
+- Issue #11079: The /Applications/Python x.x folder created by the Mac
+  OS X installers now includes a link to the installed documentation.
+
 - Issue #11054: Allow Mac OS X installer builds to again work on 10.5 with
   the system-provided Python.