Author: crossley Date: Mon Dec 6 00:04:21 2004 New Revision: 109959 URL: http://svn.apache.org/viewcvs?view=rev&rev=109959 Log: New correlate-table.sh script to scan java source files and compare with list from the xdocs table.
Added: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/correlate-table.sh (contents, props changed) Removed: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/find-component-java-files.sh Modified: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/README.txt Modified: cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/README.txt Url: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/README.txt?view=diff&rev=109959&p1=cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/README.txt&r1=109958&p2=cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/README.txt&r2=109959 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/README.txt (original) +++ cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/README.txt Mon Dec 6 00:04:21 2004 @@ -6,10 +6,11 @@ Keep the table synchronised with the java source ------------------------------------------------ Occasionally do the following ... +Find all java source files whose filename contains a component name ... cd cocoon-2_1_X - tools/review-sitemap-docs/find-component-java-files.sh -Compare with last time you ran it ... - diff component-java-files-20041206.txt component-java-files-20041201.txt + tools/review-sitemap-docs/correlate-table.sh +Compare the output listings with last time you ran it ... + diff component-java-files.txt component-java-files-20041201.txt Also compare with a listing of the files from Cocoon trunk. Add new rows to the table with copy-and-paste. Added: 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=auto&rev=109959 ============================================================================== --- (empty file) +++ cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/correlate-table.sh Mon Dec 6 00:04:21 2004 @@ -0,0 +1,43 @@ +#!/bin/bash + +# Purpose: +# Ensure that the review-sitemap-docs.xml coordination table +# remains synchronised. +# +# Procedure: +# Scan the Cocoon repository and find sitemap components java files. +# Scan the coordinate table xdoc and list the javadoc source for each entry. +# Compare with diff. +# +# Usage: +# Run this script from the top-level of the repository. +# cd /usr/local/svn/cocoon-2_1_X +# tools/review-sitemap-docs/correlate-table.sh + +echo "Scanning Cocoon repository to find sitemap components java source files." +echo " (See component-java-files.txt and do diff with that file from last run.)" +find src -name *Action.java -o -name *Generator.java \ + -o -name *Matcher.java -o -name *Reader.java \ + -o -name *Selector.java -o -name *Serializer.java \ + -o -name *Transformer.java \ +| grep -v -f tools/review-sitemap-docs/find-component-java-files-exclude.txt \ +| sort > component-java-files.txt + +echo "Listing the sitemap components java source files." +echo " (See components-source.txt)" +sed -n 's/src\/.*java\/org/org/p' component-java-files.txt \ +| sort > components-source.txt + +echo "Scanning the coordinate 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 \ +| sed 's/ <!-- 1 --><td>//;s/<\/td>//' \ +| sed 's/<link href="\.\.\/apidocs\///;s/\.html.*$/\.java/' \ +| sort > components-table.txt + +echo "Comparing the lists." +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 "----------" Deleted: /cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/find-component-java-files.sh Url: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/tools/review-sitemap-docs/find-component-java-files.sh?view=auto&rev=109958 ==============================================================================
