11466 - /docs/building-docs.txt /scripts/build-docs.sh /scripts/build-php-doc-config.php

Author: kn
Date: Tue Mar 23 10:47:55 2010
New Revision: 11466

Log:
- Made build-docs script less platform / setup dependent
- Better build-docs documentation

Modified:
    docs/building-docs.txt
    scripts/build-docs.sh
    scripts/build-php-doc-config.php

Modified: docs/building-docs.txt
==============================================================================
--- docs/building-docs.txt [iso-8859-1] (original)
+++ docs/building-docs.txt [iso-8859-1] Tue Mar 23 10:47:55 2010
 <at>  <at>  -10,12 +10,13  <at>  <at> 
 3. Make sure you have PHP 5.1 installed and working as "php" (on the
    path). You absolutely *NEED* PHP 5.1. (and not 5.2 or 5.3).

-4. Create dirs:
+4. Check that the pathes specified for SOURCE_DIR and BASE_OUTPUT_DIR match
+   your setup.

-    mkdir -p /home/httpd/html/components
+5. Run: ./scripts/build-docs.sh 2009.2rc1

-5. Configure the "SOURCE_DIR" in build-docs.sh
+6. Wait 20-714 mins and make sure you have a *lot* of free memory (2GB+)

-6. Run: ./scripts/build-docs.sh 2009.2rc1
+7. The docs will be available in ``build/`` in your working directory.

-7. Wait 20-714 mins and make sure you have a *lot* of free memory (2GB+)
+8. Execute the echo'd commands to release the documentation.

Modified: scripts/build-docs.sh
==============================================================================
--- scripts/build-docs.sh [iso-8859-1] (original)
+++ scripts/build-docs.sh [iso-8859-1] Tue Mar 23 10:47:55 2010
 <at>  <at>  -7,10 +7,9  <at>  <at> 

 release=$1

-BASE_OUTPUT_DIR=/home/httpd/html/components
+SOURCE_DIR="`pwd`"
+BASE_OUTPUT_DIR="`pwd`/build/"
 DOC_OUTPUT_DIR=${BASE_OUTPUT_DIR}/phpdoc_gen/ezcomponents-${release}
-HTTP_ROOT_DIR=/components/phpdoc_gen/ezcomponents-${release}
-SOURCE_DIR=/home/derick/dev/ezcomponents

 wd=`pwd`

 <at>  <at>  -18,7 +17,7  <at>  <at> 
 rm -rf ${BASE_OUTPUT_DIR}/cdocs-${release}.tgz || exit 7

 mkdir -p ${DOC_OUTPUT_DIR}
-ln -s /home/httpd/html/components/design ${DOC_OUTPUT_DIR}/design
+#ln -s /home/httpd/html/components/design ${DOC_OUTPUT_DIR}/design

 echo "Copying overview"
 cp docs/overview.tpl ${DOC_OUTPUT_DIR} || exit 12
 <at>  <at>  -27,7 +26,7  <at>  <at> 

 echo "Writing config file for $release"
 cd $wd
-php scripts/build-php-doc-config.php ${SOURCE_DIR} $release $release on >
/tmp/doc-components.ini || exit 1
+php scripts/build-php-doc-config.php ${SOURCE_DIR} ${DOC_OUTPUT_DIR} $release on >
/tmp/doc-components.ini || exit 1

 j=`php scripts/list-export-dirs.php $release`

 <at>  <at>  -35,11 +34,14  <at>  <at> 

 mkdir -p ${DOC_OUTPUT_DIR} || exit 8

-echo "Copying overview for $release"
-cp docs/overview_$release.tpl ${DOC_OUTPUT_DIR}
+#  <at> todo: Such files do not exist - what is this supposed to do?
+#echo "Copying overview for $release"
+#cp docs/overview_$release.tpl ${DOC_OUTPUT_DIR}
+# Trying to fix that:
+cp docs/overview.tpl "${DOC_OUTPUT_DIR}/overview_${release}.tpl"

 echo "Running php documentor for $release"
-php-5.1dev /usr/local/bin/phpdoc -q on -c /tmp/doc-components.ini >/tmp/docbuild-$release.log
2>&1 || exit 8
+phpdoc -q on -c /tmp/doc-components.ini >/tmp/docbuild-$release.log 2>&1 || exit 8
 ./scripts/setup-env.sh

 echo "Writing left_menu_comp_$release.tpl"
 <at>  <at>  -103,7 +105,7  <at>  <at> 
 		extra2=""
 		for t in $i/docs/*.txt; do
 			branch=`echo $t | cut -d / -f 1`;
-			if test $branch == "trunk"; then
+			if test "$branch" = "trunk"; then
 				output_name=`echo $t | cut -d / -f 4 | sed 's/.txt/.html/'`;
 			else
 				output_name=`echo $t | cut -d / -f 5 | sed 's/.txt/.html/'`;
 <at>  <at>  -189,6 +191,10  <at>  <at> 
 cd ..
 gzip -c -9 cdocs-${release}.tar > cdocs-${release}.tgz || exit 12
 rm cdocs-${release}.tar
-scp -i /home/derick/.ssh/id_ezdoc_rsa -p cdocs-${release}.tgz components:.
-ssh -i /home/derick/.ssh/id_ezdoc_rsa components ./copy-doc.sh cdocs-${release}.tgz
-echo "scp -p cdocs-${release}.tgz components:."
+
+echo
+echo
+echo "Now execute:"
+echo "scp -p ${BASE_OUTPUT_DIR}cdocs-${release}.tgz components.ez.no:"
+echo "ssh components.ez.no ./copy-doc.sh cdocs-${release}.tgz"
+

Modified: scripts/build-php-doc-config.php
==============================================================================
--- scripts/build-php-doc-config.php [iso-8859-1] (original)
+++ scripts/build-php-doc-config.php [iso-8859-1] Tue Mar 23 10:47:55 2010
 <at>  <at>  -3,11 +3,11  <at>  <at> 

 if ( $argc < 4 )
 {
-    echo "Usage:\n\tscripts/build-php-doc-config.php <sourcedir> <targetversion> <releaseversion>
<source:on off>\n\tscripts/package.php /home/derick/dev/ezcomponents 1.0beta1 trunk on\n\n";
+    echo "Usage:\n\tscripts/build-php-doc-config.php <sourcedir> <targetdir> <releaseversion>
<source:on off>\n\tscripts/package.php /home/derick/dev/ezcomponents 1.0beta1 trunk on\n\n";
     die();
 }
 $sourcedir = $argv[1];
-$targetversion = $argv[2];
+$target = $argv[2];
 $releaseversion = $argv[3];
 $source = $argv[4];
 $fileName = "release-info/$releaseversion";
 <at>  <at>  -46,7 +46,7  <at>  <at> 
 defaultcategoryname = NoCategoryName
 defaultpackagename = NoPackageName

-target = /home/httpd/html/components/phpdoc_gen/ezcomponents-$targetversion
+target = $target
 directory = $directories

 ignore = autoload/,*autoload.php,tests/,docs/,design/