Author: crossley Date: Fri Dec 17 20:29:53 2004 New Revision: 122705 URL: http://svn.apache.org/viewcvs?view=rev&rev=122705 Log: Ensure that we are running from the top-level source. Ensure that javadocs have been built. Add 'diff filename-1 filename 2' headers to each diff to assist interpretation. Avoid some sitemapTask components that we won't bother documenting, e.g. poor woody. Count the number of lines in all components data files.
Modified: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/correlate-table.sh Modified: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/correlate-table.sh Url: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/correlate-table.sh?view=diff&rev=122705&p1=cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/correlate-table.sh&r1=122704&p2=cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/correlate-table.sh&r2=122705 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/correlate-table.sh (original) +++ cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/correlate-table.sh Fri Dec 17 20:29:53 2004 @@ -14,6 +14,17 @@ # cd /usr/local/svn/cocoon-2_1_X # tools/review-sitemap-docs/correlate-table.sh +if [ ! -e cocoon.sh ]; then + echo "Please run from top-level of cocoon source." + echo " cd cocoon-2_1_X; tools/review-sitemap-docs/correlate-table.sh" + exit +fi + +if [ ! -e build/cocoon-2.1.7-dev/javadocs ]; then + echo "Please run 'build javadocs' first" + exit +fi + echo echo "Scanning Cocoon javadocs to find sitemap components java source files." echo " (See components-source.txt and do diff with that file from last run.)" @@ -36,24 +47,32 @@ echo "Whitespace lines are table entries which are missing a javadoc reference." echo "doing 'diff components-source.txt components-table.txt'" echo " (See components-javadoc-diff.txt)" -diff components-source.txt components-table.txt > components-javadoc-diff.txt +echo "[localhost]$ diff components-source.txt components-table.txt" > components-javadoc-diff.txt +echo " < >" >> components-javadoc-diff.txt +diff components-source.txt components-table.txt >> components-javadoc-diff.txt echo echo "Comparing the list obtained via javadocs with that obtained via SitemapTask." echo "doing 'diff components-source.txt components-sitemaptask.txt'" echo " (See components-javadoc-sitemaptask-diff.txt)" +echo "[localhost]$ diff components-source.txt components-sitemaptask.txt" > components-javadoc-sitemaptask-diff.txt +echo " < >" >> components-javadoc-sitemaptask-diff.txt cat build/all-sitemap-components.txt build/all-sitemap-components-blocks.txt \ -| sed 's/\./\//g' | sort > components-sitemaptask.txt +| sed 's/\./\//g' \ +| grep -v -f tools/review-sitemap-docs/grep-sitemaptask-exclude.txt \ +| sort > components-sitemaptask.txt diff components-source.txt components-sitemaptask.txt \ -> components-javadoc-sitemaptask-diff.txt +>> components-javadoc-sitemaptask-diff.txt echo echo "Comparing the table list with the list obtained via SitemapTask." echo "Whitespace lines are table entries which are missing a javadoc reference." echo "doing 'diff components-sitemaptask.txt components-table.txt'" echo " (See components-sitemaptask-diff.txt)" -diff components-sitemaptask.txt components-table.txt > components-sitemaptask-diff.txt +echo "[localhost]$ diff components-sitemaptask.txt components-table.txt" > components-sitemaptask-diff.txt +echo " < >" >> components-sitemaptask-diff.txt +diff components-sitemaptask.txt components-table.txt >> components-sitemaptask-diff.txt echo -echo "Counting the number of components in the table." -wc -l components-table.txt +echo "Counting the number of lines in components data files." +wc -l components-*.txt
