Skip to main content
Jump to: navigation, search

Difference between revisions of "Papyrus/Code Standards"

(Features)
(Coding rules for Papyrus plug-ins and features)
Line 46: Line 46:
 
<br>
 
<br>
  
[[Image:Papyrus.Build.properties-selectedOptions.png|1000px|thumb|left]]
+
[[Image:Papyrus.Build.properties-selectedOptions.png|1000px|thumb|none]]
 +
 
 +
<br>
  
 
==Additional information for the build process==
 
==Additional information for the build process==
The build process also needs to know where is the license. In the main pom.xml file (often in the pom.xml of ''releng/folder''), you must write:  
+
The build process also needs to know where is the license. There are 2 solutions :
 +
===Option 1===
 +
In the main pom.xml file (often in the pom.xml of ''releng/folder''), you must write:  
  
 
  <repositories>
 
  <repositories>
Line 59: Line 63:
 
  </repositories>
 
  </repositories>
  
 +
===Option 2===
 
Your target platform definition file (tpd) must also contains:  
 
Your target platform definition file (tpd) must also contains:  
 
  location "http://download.eclipse.org/cbi/updates/license/" eclipse-license {
 
  location "http://download.eclipse.org/cbi/updates/license/" eclipse-license {

Revision as of 10:17, 19 November 2020

Coding rules for Papyrus plug-ins and features

These rules apply to all plug-ins and features developed for the Papyrus Eclipse project, and distributed under the EPL licence.


Features

  • ID:
    • Main Papyrus components: org.eclipse.papyrus.<feature.name>.feature
      • e.g. org.eclipse.papyrus.infra.core.feature
  • Name: Papyrus <Feature Name>
  • Each feature.xml file must contains:

Copyright (c) 20XX CEA LIST
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0

CopyrightNoticeFeature.png
    • in Information Tab -> License Agreement
      • Check the field Shared License,
      • License Feature ID: org.eclipse.license,
      • License Feature Version: 2.0.2.
LicenseAgreementFeature.png
  • The build.properties file must contain the following files in the "Binary build" section:
    • feature.properties (When available)
    • feature.xml


Papyrus.Build.properties-selectedOptions.png


Additional information for the build process

The build process also needs to know where is the license. There are 2 solutions :

Option 1

In the main pom.xml file (often in the pom.xml of releng/folder), you must write:

<repositories>
		<repository>
			<id>license-feature</id>
			<url>http://download.eclipse.org/cbi/updates/license/</url>
			<layout>p2</layout>
		</repository>
</repositories>

Option 2

Your target platform definition file (tpd) must also contains:

location "http://download.eclipse.org/cbi/updates/license/" eclipse-license {
 org.eclipse.license.feature.group lazy
}

Back to the top