[#HADOOP-2993] Specify which JAVA_HOME should be set

Hadoop Common

Specify which JAVA_HOME should be set

Created: 11/Mar/08 01:17 AM Updated: 21/May/08 08:05 PM

Return to search

Component/s:

documentation

Affects Version/s:

site

Fix Version/s:

0.17.0

Time Tracking:

Original Estimate:

0.08h

Remaining Estimate:

0.08h

Time Spent:

Not Specified

File Attachments:

File Name	Date Attached	Attached By	Size
2993.patch	2008-04-11 07:07 AM	Edward J. Yoon	0.8 kB
HADOOP-2993_1_20080411.patch	2008-04-11 09:37 PM	Arun C Murthy	3 kB

Environment:

irrelevant---issue w/ web documentation

Hadoop Flags:	Reviewed
Resolution Date:	13/Apr/08 05:07 AM

Description

« Hide

Quickstart page (http://hadoop.apache.org/core/docs/current/quickstart.html) specifies that user should set JAVA_HOME under "1." of "Required Software". But, it does not specify where this should be set. My instinct (as would be the instinct of any un*x user) was to set this in his/her shell/profie/rcfile. Please specify that this should be specified in conf/hadoop-env.sh. Yes, this is clarified later under "Download", but is easy to miss, especially since the user will think that he/she had already set JAVA_HOME.

All

Comments

Work Log

Change History

Subversion Commits

Sort Order:

[ Permlink | « Hide ]

Edward J. Yoon added a comment - 11/Apr/08 06:58 AM

That means the setting of the environment variable JAVA_HOME to the root of your Java installation under your OS.
I don't think it must be fix, but i think we need to explain sth clearly to save confusion. +1

[ Permlink | « Hide ]

Edward J. Yoon added a comment - 11/Apr/08 07:03 AM

It should probably be explained
"Set the environment variable JAVA_HOME to the directory where you installed Java."
rather than
"Set JAVA_HOME to the root of your Java installation."

[ Permlink | « Hide ]

Edward J. Yoon added a comment - 11/Apr/08 07:07 AM

Uploading patch.

[ Permlink | « Hide ]

Edward J. Yoon added a comment - 11/Apr/08 07:07 AM

Submitting.

[ Permlink | « Hide ]

Hadoop QA added a comment - 11/Apr/08 08:36 AM

-1 overall. Here are the results of testing the latest attachment
http://issues.apache.org/jira/secure/attachment/12379904/2993.patch
against trunk revision 645773.

@author +1. The patch does not contain any @author tags.

tests included -1. The patch doesn't appear to include any new or modified tests.
Please justify why no tests are needed for this patch.

javadoc +1. The javadoc tool did not generate any warning messages.

javac +1. The applied patch does not generate any new javac compiler warnings.

release audit +1. The applied patch does not generate any new release audit warnings.

findbugs +1. The patch does not introduce any new Findbugs warnings.

core tests +1. The patch passed core unit tests.

contrib tests +1. The patch passed contrib unit tests.

Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch/2205/testReport/
Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch/2205/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch/2205/artifact/trunk/build/test/checkstyle-errors.html
Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch/2205/console

This message is automatically generated.

[ Permlink | « Hide ]

Jason Rennie added a comment - 11/Apr/08 02:09 PM

Hi Edward,

This change doesn't address the issue I raised---where the variable is to be
changed. A better sentence would be:

Set JAVA_HOME in conf/hadoop-env.sh to the root of your Java installation.

Cheers,

Jason

On Fri, Apr 11, 2008 at 3:04 AM, Edward J. Yoon (JIRA) <jira@apache.org>

–
Jason Rennie
Head of Machine Learning Technologies, StyleFeeder
http://www.stylefeeder.com/
Samantha's blog & pictures: http://samanthalyrarennie.blogspot.com/

[ Permlink | « Hide ]

Arun C Murthy added a comment - 11/Apr/08 03:03 PM

Jason, I understand where you are coming from.

Would it be more clear if we just had:

Required Software

   1. JavaTM 1.5.x, preferably from Sun, must be installed.

and then this section (later in quickstart.html) is sufficient:

Download

First, you need to get a Hadoop distribution: download a recent stable release and unpack it.

Once done, in the distribution edit the file conf/hadoop-env.sh to define at least JAVA_HOME.

Basically I'm proposing we remove the confusing reference from the 'Required Software' section.

Thoughts?

[ Permlink | « Hide ]

Edward J. Yoon added a comment - 11/Apr/08 03:10 PM - edited

>> Basically I'm proposing we remove the confusing reference from the 'Required Software' section.
~~1. I think 'Required Software' is a must.~~

Sorry, I was mis-read your comment.

[ Permlink | « Hide ]

Jason Rennie added a comment - 11/Apr/08 03:13 PM

That works---should reduce confusion

Cheers,

Jason

On Fri, Apr 11, 2008 at 11:04 AM, Arun C Murthy (JIRA) <jira@apache.org>

–
Jason Rennie
Head of Machine Learning Technologies, StyleFeeder
http://www.stylefeeder.com/
Samantha's blog & pictures: http://samanthalyrarennie.blogspot.com/

[ Permlink | « Hide ]

Arun C Murthy added a comment - 11/Apr/08 03:26 PM

Maybe we should also split the 'Download' section into 'Download' and 'Prepare to Start your Hadoop Cluster' sections, the latter of which will talk about editing conf/hadoop-env.sh and introduce the various mdoes (local, psuedo-distributed & fully-distributed) of operation...

[ Permlink | « Hide ]

Edward J. Yoon added a comment - 11/Apr/08 03:43 PM

I was often met with exceptions by GNU java. So, I think 'remove' is not good idea from the "Installing Java and Set JAVA_HOME"; User need to set the JAVA_HOME environment variable to the root location of the Java installation directory.