[jira] [Updated] (PIG-3193) Fix "ant docs" warnings

["Cheolsoo Park (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/PIG-3193?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Cheolsoo Park updated PIG-3193:
-------------------------------

    Attachment: PIG-3193.patch

I am attaching a patch that includes the following changes:
* Fixed Javadoc symbol not found warnings. For example,
{code}
[javadoc] /home/cheolsoo/workspace/pig-svn/src/org/apache/pig/tools/grunt/GruntParser.java:302: cannot find symbol
{code}
I updated the "javadoc-all" target in build.xml to fix the classpath.
* Fixed Forrest plugin installation error:
{code}
[exec] Can't get http://forrest.apache.org/plugins//0.9/org.apache.forrest.plugin.input.simplifiedDocbook.zip to /home/cheolsoo/workspace/apache-forrest-0.9/build/plugins/org.apache.forrest.plugi     n.input.simplifiedDocbook.zip
{code}
The forrest 0.9 no longer has the "simplifiedDocbook" plugin, so I removed it from "project.required.plugins" in forrest.properties.
* Removed a legacy workaround for Forrest 0.8.
{code}
# PIG-1508: Workaround for http://issues.apache.org/jira/browse/FOR-984
# Remove when forrest-0.9 is available
forrest.validate.sitemap=false
{code} 
Apache jenkins uses Forrest 0.9, so this should be fine.
* Fixed Forrest unresolved id warnings. For example, 
{code}
[exec] WARN - Page 2: Unresolved id reference "Case-Sensitivity" found.
{code}
These warnings result with broken links in html docs.

I am NOT fixing the following warnings.
* Javadoc comment warnings. e.g.
{code}
LoadCaster.java:143: warning - @param argument "fieldSchema" is not a parameter name.
{code}
There are 165 of them, so I will address them in a separate jira.
* Forrest overflow warnings. e.g.
{code}
[exec] WARN - Line 1 of a paragraph overflows the available area by 1750mpt. (fo:block, "chararray")
{code}
This is because the text of the source tag is too wide, and it is apparently a bug in Forrest 0.9 (FOR-1104).
                
> Fix "ant docs" warnings
> -----------------------
>
>                 Key: PIG-3193
>                 URL: https://issues.apache.org/jira/browse/PIG-3193
>             Project: Pig
>          Issue Type: Bug
>          Components: build, documentation
>    Affects Versions: 0.11
>            Reporter: Cheolsoo Park
>              Labels: newbie
>             Fix For: 0.12
>
>         Attachments: PIG-3193.patch
>
>
> I see many warnings every time when I run "ant clean docs". They don't break build, but it would be nice if we could clean them if possible.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira