Difference between revisions of "EclipseLink/Development/FAQ"

From Eclipsepedia

Jump to: navigation, search
Line 1: Line 1:
 
This page is dedicated to Frequently Asked Questions from committers and contributors. The content is focussed on the development process, bugzilla usage, build process, and testing. The consumer facing FAQ is available [[EclipseLink/FAQ | here]].
 
This page is dedicated to Frequently Asked Questions from committers and contributors. The content is focussed on the development process, bugzilla usage, build process, and testing. The consumer facing FAQ is available [[EclipseLink/FAQ | here]].
  
== Components ==
 
  
== Bugs ==
 
  
== Build ==
+
=== How do I modify the header for an existing class  ===
  
== Testing ==
+
When modifying an existing class in EclipseLink a committer needs to update the header to properly reflect the change history and update the copyright information. The basic guidelines are available [http://www.eclipse.org/legal/copyrightandlicensenotice.php here]
  
== Utilities ==
+
The changes can be summarized as:
 +
 
 +
1. If the copyright date range does not include the current year increase the final date or if the copyright line only has an initial date then add the current year.
 +
 
 +
2. If your company is not listed in the copyright line you need to follow one of the following two approaches to add it:
 +
 
 +
2.1. List all entities involved within the copyright notice
 +
<source lang=java>
 +
/*******************************************************************************
 +
* Copyright (c) 1998, 2008 Oracle Corporation, Sun Microsystems, Inc. All rights reserved.
 +
* This program and the accompanying materials are made available under the
 +
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 +
* which accompanies this distribution.
 +
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 +
* and the Eclipse Distribution License is available at
 +
* http://www.eclipse.org/org/documents/edl-v10.php.
 +
*
 +
* Contributors:
 +
*    Oracle - initial API and implementation from Oracle TopLink
 +
*    mmeswani - Adding the class to test default listeners (bug 227046)
 +
******************************************************************************/ 
 +
</source>
 +
 
 +
 
 +
2.2. Add 'and others' after the Initial copyright owner
 +
 
 +
This approach may work better as the number of individuals or organizations involved increases.
 +
 
 +
<source lang=java>
 +
/*******************************************************************************
 +
* Copyright (c) 1998, 2008 Oracle Corporation and others. All rights reserved.
 +
* This program and the accompanying materials are made available under the
 +
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 +
* which accompanies this distribution.
 +
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 +
* and the Eclipse Distribution License is available at
 +
* http://www.eclipse.org/org/documents/edl-v10.php.
 +
*
 +
* Contributors:
 +
*    Oracle - initial API and implementation from Oracle TopLink
 +
*    mmeswani (Sun Microsystems, Inc) - Adding the class to test default listeners (bug 227046)
 +
******************************************************************************/ 
 +
 
 +
3. Add you committer id, company (optional), description of change, and bug # to the contributors section of the header

Revision as of 11:47, 17 April 2008

This page is dedicated to Frequently Asked Questions from committers and contributors. The content is focussed on the development process, bugzilla usage, build process, and testing. The consumer facing FAQ is available here.


How do I modify the header for an existing class

When modifying an existing class in EclipseLink a committer needs to update the header to properly reflect the change history and update the copyright information. The basic guidelines are available here

The changes can be summarized as:

1. If the copyright date range does not include the current year increase the final date or if the copyright line only has an initial date then add the current year.

2. If your company is not listed in the copyright line you need to follow one of the following two approaches to add it:

2.1. List all entities involved within the copyright notice

/*******************************************************************************
 * Copyright (c) 1998, 2008 Oracle Corporation, Sun Microsystems, Inc. All rights reserved.
 * This program and the accompanying materials are made available under the 
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0 
 * which accompanies this distribution. 
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at 
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *     Oracle - initial API and implementation from Oracle TopLink
 *     mmeswani - Adding the class to test default listeners (bug 227046)
 ******************************************************************************/


2.2. Add 'and others' after the Initial copyright owner

This approach may work better as the number of individuals or organizations involved increases.

/*******************************************************************************
 * Copyright (c) 1998, 2008 Oracle Corporation and others. All rights reserved.
 * This program and the accompanying materials are made available under the 
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0 
 * which accompanies this distribution. 
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at 
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *     Oracle - initial API and implementation from Oracle TopLink
 *     mmeswani (Sun Microsystems, Inc) - Adding the class to test default listeners (bug 227046)
 ******************************************************************************/  
 
3. Add you committer id, company (optional), description of change, and bug # to the contributors section of the header