Issue Details (XML | Word | Printable)

Key: HADOOP-4920
Type: Improvement Improvement
Status: Closed Closed
Resolution: Fixed
Priority: Major Major
Assignee: Doug Cutting
Reporter: Doug Cutting
Votes: 0
Watchers: 3
Operations

If you were logged in you would be able to see more operations.
Hadoop Common

do not keep forrest output in subversion

Created: 19/Dec/08 05:33 PM   Updated: 23/Apr/09 07:18 PM
Return to search
Component/s: documentation
Affects Version/s: None
Fix Version/s: 0.20.0

Time Tracking:
Not Specified

File Attachments:
  Size
Text File Licensed for inclusion in ASF works HADOOP-4920.patch 2008-12-22 07:33 PM Doug Cutting 7 kB
File Licensed for inclusion in ASF works HADOOP-4920.sh 2008-12-22 07:30 PM Doug Cutting 0.1 kB
Issue Links:
Dependants
 

Resolution Date: 23/Dec/08 06:36 PM


 Description  « Hide
We currently re-generate PDF and HTML documentation whenever we commit a
documentation patch, which creates huge commit messages that few read. This was
originally done so that folks who check out the sources from subversion did not
need to install forrest in order to read the documentation.

Note, this issue only concerns the versioned documentation included in trunk and releases, not the website, whose forrest output should continue to be kept in subversion.



 All   Comments   Work Log   Change History   Subversion Commits      Sort Order: Ascending order - Click to sort in descending order
Doug Cutting added a comment - 19/Dec/08 05:36 PM
To fix this, I suggest we change build.xml to put generated docs in build/, not docs/. The docs/ directory would be removed.

Doug Cutting added a comment - 22/Dec/08 07:30 PM
Attached shell script to be run before patch is applied.

Doug Cutting added a comment - 22/Dec/08 07:33 PM
Attach patch to build documentation in build/docs/ rather than docs/. This will not pass Hudson, since it depends on jdiff files that are moved from docs/ to lib/.

Tsz Wo (Nicholas), SZE added a comment - 23/Dec/08 06:07 PM
Shell the value of the property "build.docs.cn" be "${build.dir}/docs/cn", instead of "${basedir}/docs/cn" ?

Otherwise, patch looks good.


Doug Cutting added a comment - 23/Dec/08 06:36 PM
I just committed this.

Should we merge this to the 0.19 branch? We will have to adjust release procedures a bit, since the docs for releases will not be in subversion, on the website, they must now, like javadoc, be unpacked from the release rather than retrieved from a subversion tag. Perhaps better to address this now, while it's fresh in our minds, rather than when we get to 0.20? Nigel?


Tsz Wo (Nicholas), SZE added a comment - 28/Dec/08 07:56 PM
This is only committed to trunk, i.e. 0.21, but not yet committed to 0.20.

Nigel Daley added a comment - 24/Jan/09 09:20 PM
Doug, let's just commit this to 0.20 (can you merge?). I'll keep track of this issue and do the right things for releases. I'll update HowToRelease wiki when I release 0.20.

Doug Cutting added a comment - 26/Jan/09 09:19 PM
> Doug, let's just commit this to 0.20 (can you merge?).

Done.