You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by "Alexei Fedotov (JIRA)" <ji...@apache.org> on 2006/11/10 22:43:39 UTC
[jira] Created: (HARMONY-2150) [doc] getting_started.html is
outdated
[doc] getting_started.html is outdated
--------------------------------------
Key: HARMONY-2150
URL: http://issues.apache.org/jira/browse/HARMONY-2150
Project: Harmony
Issue Type: Bug
Reporter: Alexei Fedotov
Pavel Ozhdikhin wrote at
http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3c469bff730611080622p8c04144yaadff2bc4a53cb58@mail.gmail.com%3e
The document http://incubator.apache.org/harmony/subcomponents/drlvm/getting_started.html is completely outdated, for example:
- the term DRL is used instead of DRLVM
- eclipse.bat and eclipse.sh are obsolete - we don't need them anymore
to run Eclipse. It can be started with DRLVM the same way as with any other
VM.
- We don't need to set PATH and LD_LIBRARY_PATH anymore, at least on
Windows/MSVC
- ij was renamed to java
Mikhail added at
http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3cbc79dd600611080702w5f725ac6lf43c029c755aa2a4@mail.gmail.com%3e
It's not a hard to write a documenation once, it's hard to support it :)
More problems:
1) -Xem options are obsolete.
2) -Xjit options are also obsolete.
3) Do we really need this page today? AFAIU users expect Harmony VM is able
to run the same apps as RI..
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (HARMONY-2150) [doc] getting_started.html is
outdated
Posted by "Pavel Ozhdikhin (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-2150?page=comments#action_12450293 ]
Pavel Ozhdikhin commented on HARMONY-2150:
------------------------------------------
Nadya,
A minor comment about step 2 in the "Debugging..." section:
Text:
Start the debug operation on your class - HelloWorld.java in the example.
After the debug run completes, the workspace gets updated with new results.
Comments:
- The class name is HelloWorld. HelloWorld.java is a name of the source-file.
- I think the debug run is not complete at this point but is suspended at the breakpoint.
Suggested text:
Start the debug operation on your class - HelloWorld in the example.
Once a debug run stops at the breakpoint, the debug information will appear in the Debug tab of your workspace and you will be able to inspect runtime values and control further execution.
Otherwise the text looks fine to me.
Thanks,
Pavel
> [doc] getting_started.html is outdated
> --------------------------------------
>
> Key: HARMONY-2150
> URL: http://issues.apache.org/jira/browse/HARMONY-2150
> Project: Harmony
> Issue Type: Bug
> Components: Website/Documentation
> Reporter: Alexei Fedotov
> Attachments: getting_started.patch, getting_started_update.patch
>
>
> Pavel Ozhdikhin wrote at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3c469bff730611080622p8c04144yaadff2bc4a53cb58@mail.gmail.com%3e
> The document http://incubator.apache.org/harmony/subcomponents/drlvm/getting_started.html is completely outdated, for example:
> - the term DRL is used instead of DRLVM
> - eclipse.bat and eclipse.sh are obsolete - we don't need them anymore
> to run Eclipse. It can be started with DRLVM the same way as with any other
> VM.
> - We don't need to set PATH and LD_LIBRARY_PATH anymore, at least on
> Windows/MSVC
> - ij was renamed to java
> Mikhail added at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3cbc79dd600611080702w5f725ac6lf43c029c755aa2a4@mail.gmail.com%3e
> It's not a hard to write a documenation once, it's hard to support it :)
> More problems:
> 1) -Xem options are obsolete.
> 2) -Xjit options are also obsolete.
> 3) Do we really need this page today? AFAIU users expect Harmony VM is able
> to run the same apps as RI..
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (HARMONY-2150) [doc] getting_started.html is
outdated
Posted by "Nadya Morozova (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-2150?page=all ]
Nadya Morozova updated HARMONY-2150:
------------------------------------
Attachment: getting_started_update.patch
Pavel,
thanks for nice review feedback. i've updated the patch based on your suggestions. The patch with _updated marker can be used as the more complete fix. I am ready to fix any further issues if more reviews arrive.
thanks, Nadya
> [doc] getting_started.html is outdated
> --------------------------------------
>
> Key: HARMONY-2150
> URL: http://issues.apache.org/jira/browse/HARMONY-2150
> Project: Harmony
> Issue Type: Bug
> Components: Website/Documentation
> Reporter: Alexei Fedotov
> Attachments: getting_started.patch, getting_started_update.patch
>
>
> Pavel Ozhdikhin wrote at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3c469bff730611080622p8c04144yaadff2bc4a53cb58@mail.gmail.com%3e
> The document http://incubator.apache.org/harmony/subcomponents/drlvm/getting_started.html is completely outdated, for example:
> - the term DRL is used instead of DRLVM
> - eclipse.bat and eclipse.sh are obsolete - we don't need them anymore
> to run Eclipse. It can be started with DRLVM the same way as with any other
> VM.
> - We don't need to set PATH and LD_LIBRARY_PATH anymore, at least on
> Windows/MSVC
> - ij was renamed to java
> Mikhail added at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3cbc79dd600611080702w5f725ac6lf43c029c755aa2a4@mail.gmail.com%3e
> It's not a hard to write a documenation once, it's hard to support it :)
> More problems:
> 1) -Xem options are obsolete.
> 2) -Xjit options are also obsolete.
> 3) Do we really need this page today? AFAIU users expect Harmony VM is able
> to run the same apps as RI..
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (HARMONY-2150) [doc] getting_started.html is
outdated
Posted by "Nadya Morozova (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-2150?page=all ]
Nadya Morozova updated HARMONY-2150:
------------------------------------
Attachment: getting_started.patch
The patch contains an abridged version of the getting started document featuring:
- rewritten intro sections: maximum links to other relevant materials
- repplaced section with cmd options with a link to the wiki page
- abridged eclipse-related scenarios to decrease the level of detail and remove screenshots.
this is not the final version of the page because:
- several TODOs are left that require others' attention
- the new section about using cmd options to modify VM operation is empty. here's where i hope to see some nice howtos.
- more additions are welcome
- we might decide to remove eclipse scenarios at all, though i'd vote against it.
Please take a look and express your opinion.
> [doc] getting_started.html is outdated
> --------------------------------------
>
> Key: HARMONY-2150
> URL: http://issues.apache.org/jira/browse/HARMONY-2150
> Project: Harmony
> Issue Type: Bug
> Components: Website/Documentation
> Reporter: Alexei Fedotov
> Attachments: getting_started.patch
>
>
> Pavel Ozhdikhin wrote at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3c469bff730611080622p8c04144yaadff2bc4a53cb58@mail.gmail.com%3e
> The document http://incubator.apache.org/harmony/subcomponents/drlvm/getting_started.html is completely outdated, for example:
> - the term DRL is used instead of DRLVM
> - eclipse.bat and eclipse.sh are obsolete - we don't need them anymore
> to run Eclipse. It can be started with DRLVM the same way as with any other
> VM.
> - We don't need to set PATH and LD_LIBRARY_PATH anymore, at least on
> Windows/MSVC
> - ij was renamed to java
> Mikhail added at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3cbc79dd600611080702w5f725ac6lf43c029c755aa2a4@mail.gmail.com%3e
> It's not a hard to write a documenation once, it's hard to support it :)
> More problems:
> 1) -Xem options are obsolete.
> 2) -Xjit options are also obsolete.
> 3) Do we really need this page today? AFAIU users expect Harmony VM is able
> to run the same apps as RI..
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (HARMONY-2150) [doc] getting_started.html is
outdated
Posted by "Gregory Shimansky (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-2150?page=comments#action_12450376 ]
Gregory Shimansky commented on HARMONY-2150:
--------------------------------------------
I think the following text could be added to the debugging section. The rest of the document seems to be ok to me.
To start debugging use Run->Debug menu. This will open a dialog box. Choose "Java Application" in the left menu to debug your application as a general one. To start debugging the main function choose "Stop in main" checkbox. When debugging starts Eclipse will ask you whether you would like to switch to debugging perspective. This will allow you to access debug specific menus and toolbars. Debugging perspective may be chosen before starting debug, in case you want to set breakpoints in places other than main function. In debugging perspective use Run->Toggle Line Breakpoint menu item. Use debugging perspective toolbars and windows to step in/over access local variables, etc.
> [doc] getting_started.html is outdated
> --------------------------------------
>
> Key: HARMONY-2150
> URL: http://issues.apache.org/jira/browse/HARMONY-2150
> Project: Harmony
> Issue Type: Bug
> Components: Website/Documentation
> Reporter: Alexei Fedotov
> Attachments: getting_started.patch, getting_started_update.patch
>
>
> Pavel Ozhdikhin wrote at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3c469bff730611080622p8c04144yaadff2bc4a53cb58@mail.gmail.com%3e
> The document http://incubator.apache.org/harmony/subcomponents/drlvm/getting_started.html is completely outdated, for example:
> - the term DRL is used instead of DRLVM
> - eclipse.bat and eclipse.sh are obsolete - we don't need them anymore
> to run Eclipse. It can be started with DRLVM the same way as with any other
> VM.
> - We don't need to set PATH and LD_LIBRARY_PATH anymore, at least on
> Windows/MSVC
> - ij was renamed to java
> Mikhail added at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3cbc79dd600611080702w5f725ac6lf43c029c755aa2a4@mail.gmail.com%3e
> It's not a hard to write a documenation once, it's hard to support it :)
> More problems:
> 1) -Xem options are obsolete.
> 2) -Xjit options are also obsolete.
> 3) Do we really need this page today? AFAIU users expect Harmony VM is able
> to run the same apps as RI..
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (HARMONY-2150) [doc] getting_started.html is
outdated
Posted by "Nadya Morozova (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-2150?page=comments#action_12450469 ]
Nadya Morozova commented on HARMONY-2150:
-----------------------------------------
thanks for your feedback. i've added most of it and have one question.
Gregory, do i understand that your text
"To start debugging the main function choose "Stop in main" checkbox."
is instead of the old text
"Set up the breakpoint for debug purposes. In the example with the HelloWorld class, set the breakpoint on the following line: System.out.println ("Hello, World!");"?
if so, i will edit the text. i guess setting breakpoints can be a separate step, and we can explain all options - setting the breakpoint as in the example with HelloWorld class, or when configuring debug - as you suggest, or beforehand, if breakpoints should be in places other than the main function. what do you think?
thnx
> [doc] getting_started.html is outdated
> --------------------------------------
>
> Key: HARMONY-2150
> URL: http://issues.apache.org/jira/browse/HARMONY-2150
> Project: Harmony
> Issue Type: Bug
> Components: Website/Documentation
> Reporter: Alexei Fedotov
> Attachments: getting_started.patch, getting_started_update.patch
>
>
> Pavel Ozhdikhin wrote at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3c469bff730611080622p8c04144yaadff2bc4a53cb58@mail.gmail.com%3e
> The document http://incubator.apache.org/harmony/subcomponents/drlvm/getting_started.html is completely outdated, for example:
> - the term DRL is used instead of DRLVM
> - eclipse.bat and eclipse.sh are obsolete - we don't need them anymore
> to run Eclipse. It can be started with DRLVM the same way as with any other
> VM.
> - We don't need to set PATH and LD_LIBRARY_PATH anymore, at least on
> Windows/MSVC
> - ij was renamed to java
> Mikhail added at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3cbc79dd600611080702w5f725ac6lf43c029c755aa2a4@mail.gmail.com%3e
> It's not a hard to write a documenation once, it's hard to support it :)
> More problems:
> 1) -Xem options are obsolete.
> 2) -Xjit options are also obsolete.
> 3) Do we really need this page today? AFAIU users expect Harmony VM is able
> to run the same apps as RI..
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Updated: (HARMONY-2150) [doc] getting_started.html is
outdated
Posted by "Alexei Fedotov (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-2150?page=all ]
Alexei Fedotov updated HARMONY-2150:
------------------------------------
Component/s: Website/Documentation
> [doc] getting_started.html is outdated
> --------------------------------------
>
> Key: HARMONY-2150
> URL: http://issues.apache.org/jira/browse/HARMONY-2150
> Project: Harmony
> Issue Type: Bug
> Components: Website/Documentation
> Reporter: Alexei Fedotov
>
> Pavel Ozhdikhin wrote at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3c469bff730611080622p8c04144yaadff2bc4a53cb58@mail.gmail.com%3e
> The document http://incubator.apache.org/harmony/subcomponents/drlvm/getting_started.html is completely outdated, for example:
> - the term DRL is used instead of DRLVM
> - eclipse.bat and eclipse.sh are obsolete - we don't need them anymore
> to run Eclipse. It can be started with DRLVM the same way as with any other
> VM.
> - We don't need to set PATH and LD_LIBRARY_PATH anymore, at least on
> Windows/MSVC
> - ij was renamed to java
> Mikhail added at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3cbc79dd600611080702w5f725ac6lf43c029c755aa2a4@mail.gmail.com%3e
> It's not a hard to write a documenation once, it's hard to support it :)
> More problems:
> 1) -Xem options are obsolete.
> 2) -Xjit options are also obsolete.
> 3) Do we really need this page today? AFAIU users expect Harmony VM is able
> to run the same apps as RI..
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (HARMONY-2150) [doc] getting_started.html is
outdated
Posted by "Pavel Ozhdikhin (JIRA)" <ji...@apache.org>.
[ http://issues.apache.org/jira/browse/HARMONY-2150?page=comments#action_12449579 ]
Pavel Ozhdikhin commented on HARMONY-2150:
------------------------------------------
1st paragraph:
Text:
The Dynamic Runtime Layer (DRL) is a clean-room ...
Comment:
There is no DRL in Harmony, only DRLVM.
Suggested text:
The Dynamic Runtime Layer Virtual Machine (DRLVM) is a clean-room implementation of the VM for the Java 2 Platform,...
"Overview" section:
Text: ...please write to the mailing list or add your issue to the Troubleshooting listing.
Comment: Troubleshooting listing looks strange - do we really have such listing? I also prefer the word "page" instead of "listing" because "listing" usually stands for output of some program, a code dump etc.
Text: ... Wiki command-line options listing
Comment: Again, the word "listing".
Section "Running an Application":
Text: The scenario uses the Hello.class Java* class distributed with the product as the sample Java* application.
Comment: The DRLVM build does not contain Hello.class anymore. A user need to run his own application.
Text:
On Linux*, make sure that you can run applications and load dynamic libraries from the current directory. For example:
export PATH=.:${PATH}
export LD_LIBRARY_PATH=${PWD}:${LD_LIBRARY_PATH}
Comment:
I think this text is not needed anymore. On Linux I can start DRLVM without setting this manually. I'm not sure about further note about ICC libraries.
Section "Running an Application in Eclipse":
Text:
In the project workspage, create a new Java class. For example, to get a class that prints Hello World, you can create a HelloWorld class with the the public static void main(String[] args) option selected. After the class is created successfully, the workspace gets updated.
Comment:
This text is too wordy for an experienced programmer and too brief for a newbie. Either write:
In the project workspage, create HelloWorld class with the public static void main(String[] args) method containing the following code:
int i=18;
System.out.println("Hello, World!");
or repeate step-by-step instruction from the original version with the menu items etc.
Section "Configuring VM Operation ":
Why do we need this section if we give a link to the Wiki command-line options page in the overview?
I think this page also need to be reviewed by someone who knows more abou debugging using DRLVM (Gregory, Eugeny?)
> [doc] getting_started.html is outdated
> --------------------------------------
>
> Key: HARMONY-2150
> URL: http://issues.apache.org/jira/browse/HARMONY-2150
> Project: Harmony
> Issue Type: Bug
> Components: Website/Documentation
> Reporter: Alexei Fedotov
> Attachments: getting_started.patch
>
>
> Pavel Ozhdikhin wrote at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3c469bff730611080622p8c04144yaadff2bc4a53cb58@mail.gmail.com%3e
> The document http://incubator.apache.org/harmony/subcomponents/drlvm/getting_started.html is completely outdated, for example:
> - the term DRL is used instead of DRLVM
> - eclipse.bat and eclipse.sh are obsolete - we don't need them anymore
> to run Eclipse. It can be started with DRLVM the same way as with any other
> VM.
> - We don't need to set PATH and LD_LIBRARY_PATH anymore, at least on
> Windows/MSVC
> - ij was renamed to java
> Mikhail added at
> http://mail-archives.apache.org/mod_mbox/incubator-harmony-dev/200611.mbox/%3cbc79dd600611080702w5f725ac6lf43c029c755aa2a4@mail.gmail.com%3e
> It's not a hard to write a documenation once, it's hard to support it :)
> More problems:
> 1) -Xem options are obsolete.
> 2) -Xjit options are also obsolete.
> 3) Do we really need this page today? AFAIU users expect Harmony VM is able
> to run the same apps as RI..
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira