hadoop-pig-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Alan Gates (JIRA)" <j...@apache.org>
Subject [jira] Commented: (PIG-1384) Adding contrib javadoc to main Pig javadoc
Date Wed, 21 Apr 2010 20:51:49 GMT

    [ https://issues.apache.org/jira/browse/PIG-1384?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12859522#action_12859522

Alan Gates commented on PIG-1384:

I don't think we want 'ant javadoc' to build all of the contrib javadocs.  I have three reasons
for this:

# In general we have been keeping contrib builds out of default pig builds, so that users
can build pig code and docs without worrying about contrib.
# We worked hard to get all of the javadoc warnings out of main pig code.  If we put 298 warnings
in there from contrib then we'll mess up hudson and make it impossible to tell when we're
adding real warnings to core Pig javadocs.
# Trying to build all of the docs at once runs out of memory on my mac, though it works fine
on my Linux box.  So it seems that building all these docs takes more memory than your average
developer environment JVM is set up with.  We don't want to force people to change around
their JVM just to build the javadocs.

This can be done by moving {{javadoc}} target in this patch to a new target, {{javadoc-all}}.
 The old {{javadoc}} target can then be restored as is.  The {{docs}} target can then be changed
to call {{javadoc-all}} instead of {{javadoc}}.  This way developers and hudson can still
just build the javadoc for Pig, while the release process (which uses the {{tar}} target which
in turn uses the {{docs}} target) can build all of the docs.

> Adding contrib javadoc to main Pig javadoc
> ------------------------------------------
>                 Key: PIG-1384
>                 URL: https://issues.apache.org/jira/browse/PIG-1384
>             Project: Pig
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 0.7.0
>            Reporter: Daniel Dai
>            Assignee: Daniel Dai
>             Fix For: 0.7.0
>         Attachments: PIG-1384-0.7.patch, PIG-1384-trunk.patch

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

View raw message