Bug 142968 - [api] Remove String "ibm" from String constants and APIs
Summary: [api] Remove String "ibm" from String constants and APIs
Status: RESOLVED FIXED
Alias: None
Product: Target Management
Classification: Tools
Component: RSE (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P3 minor (vote)
Target Milestone: 1.0.1   Edit
Assignee: David Dykstal CLA
QA Contact: Martin Oberhuber CLA
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2006-05-22 07:50 EDT by Martin Oberhuber CLA
Modified: 2007-05-23 05:38 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Oberhuber CLA 2006-05-22 07:50:59 EDT
The RSE code should be cleaned of String "ibm" from constants and APIs before we reach 1.0 release.
Comment 1 Martin Oberhuber CLA 2006-07-03 08:45:15 EDT
Marking as [api] -- This is a must-have for M4.
Comment 2 David McKnight CLA 2006-08-01 12:10:11 EDT
I've taken out "ibm" and refactored code to not use IBM in all the places I could find.
Comment 3 Martin Oberhuber CLA 2006-08-02 08:41:47 EDT
Found "ibm" in

* patterns.dat
* popupMenus.exsd, compile.exsd, subsystemConfiguration.exsd
* DStoreConnectorService.java - getIBMServerLauncher()
* public static final String Copyright, String copyright (in several files)
* HelpContexts.xml
* RemoteServerLauncher, RemoteCmdSubSystem - getIBMAttribute(), getPropertySet("IBM")
* scripts/aix/server.sh
* systemMessages.xml
* SystemViewResources.java - RESID_PROPERTY_ORIGIN_IBM*

Comment 4 David McKnight CLA 2006-08-02 10:53:28 EDT
I've resolved more of the ibm strings.  I did not deal with the following:

* public static final String Copyright, String copyright (in several files)

Should the copyrights not continue to have IBM in them?

* HelpContexts.xml

There are references to iseries documentation links here and I'm not sure what they are doing there but it requires some investigation.  I think there ought to be a nother defect specifically to deal with that.

Comment 5 Martin Oberhuber CLA 2006-08-02 11:15:09 EDT
Regarding Copyrights:

I was told by the WR legal department that copyrights in object code (in the form of static Strings) are not relevant anyway. What counts, is the source code and the copyright comments in there. Because of this, VxWorks source code has been completely purged from static string copyrights (which used to be in every file).

I'm not sure how IBM wants to deal with this, though. 

Anyways, it's not something urgent to deal with since the copyright strings do not impact the API. It should be decided what to do with them before 1.0 release (either purge the strings or update the year from 2003 to 2006).
Comment 6 Martin Oberhuber CLA 2006-08-16 11:25:30 EDT
Did another search:
 * Search for "ibm" case insensitive not whole word all the workspace
 * Filter-out comments
 * Filter-out Regex "copyright|initial API|public license|employees contributed"

Found
 * plugin.xml -> vendor="IBM Corp" for some RSE extensions
 * Comments like "IBM-supplied" in the docs
 * HelpContexts.xml

Suggest
 * plugin.xml -> vendor="Eclipse.org"
 * "IBM-supplied" --> "Predefined"

Are you OK with these changes? - I could make the two suggested.
Also, Decreasing priority to P3 since the remaining occurrences are not urgent any more.
Comment 7 David McKnight CLA 2006-08-16 11:29:45 EDT
Those sound good to me.
Comment 8 Martin Oberhuber CLA 2006-11-16 05:50:00 EST
I searched again for "ibm" case-insensitive, not-whole word and filtered out
the following regex:
copyright|initial API|public license|employees|contributed|dykstal|mcknight|ibmjava2|ibm-java2|berger|Author

I found the following matches:

cbegin.html  "IBM Products"
CommandMinerThread  "QIBM_"
cremcompile.html "IBM supplies"
cuniversal.html "IBM iSeries"
FolderInfoPropertyPage2.html "import com.ibm.etools.systems"
HelpContext.xml "IBM-supplied types", "originally supplied by IBM"
IRemoteServerLauncher "getIbm"
ISystemModeTransferRegistry "ibm-application"
ISystemPreferenceChangeEvents "reserved for IBM"
PerformanceLogger "_ENABLE_PERFORMANCE_LOGGING_IBM_INTERNAL"
plugin.xml "ibm.files400"
popup.html "com.ibm.etools"
popupMenus.exsd "IBM-supplied", "IBM-predefined" etc.
propertyPages.exsd "IBM-supplied"
RexecDstoreServer.java "IBM Communications"
ShowJarContents2.html "com.ibm.etools"
SystemIFileProperties "IBM Debugger"
tedittype.html "IBM-supplied"
tremtype.html "IBM-supplied"
uiDialogsAPI.html "supplied by IBM"
uiMessagesCore.html "reserved by IBM"
usingAPIs.html "IBM-supplied"

I think the most important to remove are the matches
  - "com.ibm.etools"  since they are in the Javadoc and suggest that users
    should enter some code that would not compile.
  - "IBM-supplied", "supplied by IBM" should be replaced by "predefined" 
  - _ENABLE_PERFORMANCE_LOGGING_IBM_INTERNAL since it is API

For the others, I'm not sure and they could perhaps remain in there.
Comment 9 David McKnight CLA 2006-12-07 14:22:15 EST
I've removed the rest of these "ibm" strings.
Comment 10 David Dykstal CLA 2006-12-13 13:20:56 EST
I corrected 4 "IBM Supplied" or "Supplied by IBM" strings under this defect while verifying.

I Found some com.ibm.etools.... strings in the tutorial. These are in code segments that need to be verified and fixed. It would be my preference not to have these merged in with the help text but find some way to have these be in projects that are syntax-checked and still be referenced by the tutorial. These are found in the following files:
FolderInfoPropertyPage2.html
popup.html
ShowJarContents2.html

I'm going to reopen this one since there are still more bits that need to be fixed.
Comment 11 David McKnight CLA 2006-12-13 13:58:33 EST
I'll reassign this to you so you can deal with extra documentation aspects.
Comment 12 David Dykstal CLA 2006-12-14 17:06:48 EST
Fixed the com.ibm.* strings in the tutorial.