Author: crossley Date: Tue Dec 14 20:50:00 2004 New Revision: 111945 URL: http://svn.apache.org/viewcvs?view=rev&rev=111945 Log: Also compare the list obtained via scanning javadocs with that obtained via SitemapTask.
Added: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/TODO.txt (contents, props changed) Modified: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/correlate-table.sh Added: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/TODO.txt Url: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/TODO.txt?view=auto&rev=111945 ============================================================================== --- (empty file) +++ cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/TODO.txt Tue Dec 14 20:50:00 2004 @@ -0,0 +1,10 @@ +See other notes at: +http://cocoon.apache.org/2.1/plan/review-sitemap-docs.html + +* Ensure that the SitemapTask is finding all possible components. + +* The script tools/review-sitemap-docs/correlate-table.sh +also attempts to compare the lists obtained from SitemapTask +with a list obtained from scanning javadocs. The latter list +is also finding some junk, so more exclusions may need to +be added to find-component-java-files-exclude.txt 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=111945&p1=cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/correlate-table.sh&r1=111944&p2=cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/correlate-table.sh&r2=111945 ============================================================================== --- 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 Tue Dec 14 20:50:00 2004 @@ -14,6 +14,7 @@ # cd /usr/local/svn/cocoon-2_1_X # tools/review-sitemap-docs/correlate-table.sh +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.)" find build/cocoon-2.1.7-dev/javadocs -name *.html \ @@ -22,6 +23,7 @@ | sed 's/build\/.*org\//org\//;s/\.html//' \ | sort > components-source.txt +echo echo "Scanning the coordinaton table xdoc and list the javadoc sources." echo " (See components-table.txt and do diff with last time.)" grep "<\!-- 1 -->" src/documentation/xdocs/plan/review-sitemap-docs.xml \ @@ -29,12 +31,22 @@ | sed 's/<link href="\.\.\/apidocs\///;s/\.html.*$//' \ | sort > components-table.txt -echo "Comparing the lists." +echo +echo "Comparing the table list with the list obtained via javadocs." echo "Whitespace lines are table entries which are missing a javadoc reference." -echo "diff components-source.txt components-table.txt" -echo "----------" -diff components-source.txt components-table.txt -echo "----------" +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 +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)" +cat build/all-sitemap-components.txt build/all-sitemap-components-blocks.txt \ +| sed 's/\./\//g' | sort > components-sitemaptask.txt +diff components-source.txt components-sitemaptask.txt \ +> components-javadoc-sitemaptask-diff.txt + +echo echo "Counting the number of components in the table." wc -l components-table.txt
