Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 164697

Summary: Correct instructions in readme.txt for BIRT runtime package
Product: z_Archived Reporter: Sunitha Kambhampati <ksunithaghm>
Component: BIRTAssignee: Xiaoying Gu <bluesoldier>
Status: RESOLVED FIXED QA Contact:
Severity: minor    
Priority: P3 CC: wenfeng.fwd
Version: 2.2.0   
Target Milestone: 2.2.1   
Hardware: All   
OS: Windows 2000   
Whiteboard:

Description Sunitha Kambhampati CLA 2006-11-15 14:23:35 EST
I downloaded the Birt runtime.  The readme.txt has this :

" Running the BIRT Engine in Console
----------------------------------
 In order to run the BIRT engine in command you should:

   1. set BIRT_HOME to the directory where BIRT SDK is extracted.
   2. generate the report by run
       genReport xxx.rptdesign
   xxx.rptdesign is the design file. if the design file is in the
current directory, you have to specify it by .\xxx.rptdesign
"

I have some comments on improving this:
1) Instruction 2 above is not right. The genReport is not in the directory where BIRT SDK is extracted.It is under the sub directory ReportEngine.
2) Actually the BIRT_HOME should point to the ReportEngine directory.
3) The genReport.sh correctly takes care of #2 , ie by setting BIRT_HOME
to the ReportEngine directory.
 $JAVACMD -cp "$BIRTCLASSPATH" -DBIRT_HOME="$BIRT_HOME/ReportEngine"
org.eclipse.birt.report.engine.api.ReportRunner
It may be best to call the directory where the BIRT SDK is extracted as
$BIRT_SDK_HOME or some such variable and not confuse it with BIRT_HOME.

If this is something that the community thinks is a good idea to fix,  I'd be willing to fix this and submit a
patch. How can I assign myself to a bugzilla entry?

Thanks,
Sunitha.
Comment 1 Wenfeng Li CLA 2007-01-04 17:24:28 EST
Sunitha,  you are welcome to provide a patch.txt,  please attach teh readme file and source code file in this bugzilla.  A committer will review the patch and check in to Eclipse CVS.
Comment 2 Sunitha Kambhampati CLA 2007-01-04 18:08:41 EST
(In reply to comment #1)
> Sunitha,  you are welcome to provide a patch.txt,  please attach teh readme
> file and source code file in this bugzilla.  A committer will review the patch
> and check in to Eclipse CVS.
> 
Thanks for the response. I'm interested to submit a patch for this. But since this will be my first patch, I have a few questions: 

For this fix, following files that are in the birt runtime need to be updated
 a) readme.txt 
 b) genReport.bat
 c) and genReport.sh

1)I checked out the birt source, and I dont find these files in the cvs repository. Is this expected or am I missing something?
Why are these files not checked in. It seems to be better if they are checked in, isnt it ?

2)Since they are not in repository, should I just attach a new file readme.txt and the script files.  

3)In your comment, you say attach the source file -- which source file did you have in mind. 

Thanks for your time and help,
Sunitha.
Comment 3 Wenfeng Li CLA 2007-01-04 18:15:09 EST
Please attach the three files to this bugzilla entry.   We  will check them into CVS.

re: 3)In your comment, you say attach the source file -- which source file did you have in mind. 
-- the script files.
Comment 4 Sunitha Kambhampati CLA 2007-01-05 19:28:15 EST
Just to update:

I could not test my scripts changes because of bug 169714. I reported this issue and have attached a fix for it.  I also sent a review request to the birt-dev group. https://bugs.eclipse.org/bugs/show_bug.cgi?id=169714

Since both touch the scripts, I will submit the fix for this issue once the 169714  gets checked in.  Thanks. 
Comment 5 Wenfeng Li CLA 2007-05-30 21:03:20 EDT
169714  has been fixed.  (In reply to comment #4)
> Just to update:
> I could not test my scripts changes because of bug 169714. I reported this
> issue and have attached a fix for it.  I also sent a review request to the
> birt-dev group. https://bugs.eclipse.org/bugs/show_bug.cgi?id=169714
> Since both touch the scripts, I will submit the fix for this issue once the
> 169714  gets checked in.  Thanks. 

169714  has been fixed.  
Comment 6 Xiaoying Gu CLA 2007-09-12 03:21:47 EDT
Fixed.

The readme.txt was in 
/cvsroot/birt/source/org.eclipse.birt.releng.birtbuilder/extras/Attic/runtime_readme.txt

Feel free to reopen this bug if any change need to be updated also.