Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Papyrus/Papyrus Developer Guide"
m (Updated PSF files for 0.9 papyrus devs.) |
(→Retrieve code: update the documentation for the psf) |
||
Line 31: | Line 31: | ||
[[PSF]] Following files will allow you to import all Papyrus plugins used during build phase: | [[PSF]] Following files will allow you to import all Papyrus plugins used during build phase: | ||
+ | PSF files are now automatically generated using the SVN repository. They do not necessarily correspond to what is built. | ||
+ | The script used to generate them is available in this project http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/readme/ | ||
+ | The following psf files are automatically update several time by day. | ||
− | * | + | *last versions of the psf files for Papyrus/trunk using http for non-commiters: |
− | **papyrus | + | **[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/build_http.psf build_http.psf] release engineering projects |
− | **papyrus | + | **[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/extraplugins_http.psf extraplugins_http.psf] all papyrus extraplugins |
− | **papyrus | + | **[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/full_papyrus_http.psf full_papyrus_http.psf] all papyrus plugins available on the SVN |
− | ** | + | **[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/plugins_http.psf plugins_http.psf] all papyrus plugins |
+ | **[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/tests_http.psf tests_http.psf] Junit and other test plugins (mandatory for developers) | ||
+ | *last versions of the psf files for Papyrus/trunk using svn+ssh for commiters: | ||
+ | **[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/build_svn_ssh.psf build_svn_ssh.psf] release engineering projects | ||
+ | **[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/extraplugins_svn_ssh.psf extraplugins_svn_ssh.psf] all papyrus extraplugins | ||
+ | **[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/full_papyrus_svn_ssh.psf full_papyrus_svn_ssh.psf] all papyrus plugins available on the SVN | ||
+ | **[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/plugins_svn_ssh.psf plugins_svn_ssh.psf] all papyrus plugins | ||
+ | **[http://download.eclipse.org/modeling/mdt/papyrus/psf/subclipse/trunk/tests_svn_ssh.psf tests_svn_ssh.psf] Junit and other test plugins (mandatory for developers) | ||
+ | ===How to update the script generating the psf files.=== | ||
+ | The script is located on build.eclipse.org in /opt/public/modeling/mdt/papyrus/create_psf_files.sh. | ||
+ | *To modify it : | ||
+ | **download this project with Eclipse http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/readme/ | ||
+ | **modify it and commit it on the SVN | ||
+ | **log you on hudson | ||
+ | **execute the script /opt/public/modeling/mdt/papyrus/update_psf_files_script.sh. This script allows to download and "install" the last version of the scripts located in trunk/readme/script (so it updates itself too) | ||
+ | |||
+ | |||
+ | ===How to update the psf files provided in /trunk/readme.=== | ||
+ | Coming soon | ||
=== Retrieve configuration files === | === Retrieve configuration files === |
Revision as of 08:44, 15 June 2012
Contents
Development Environment
To ease the development on Papyrus, each member of the team works with basically the same configuration.
Common Environment
Following is a description of the basic configuration:
Required External Plugins
Papyrus requires some external plugins in order to compile.
The following page maintain a list of Papyrus Required External Plugins
Development Plan
Specifications
The specifications are available here : http://wiki.eclipse.org/Papyrus_Developer_Guide/Specifications
Getting the code
Connecting to the svn
The code is available under svn at this location http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/
Retrieve code
PSF Following files will allow you to import all Papyrus plugins used during build phase: PSF files are now automatically generated using the SVN repository. They do not necessarily correspond to what is built. The script used to generate them is available in this project http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/readme/ The following psf files are automatically update several time by day.
- last versions of the psf files for Papyrus/trunk using http for non-commiters:
- build_http.psf release engineering projects
- extraplugins_http.psf all papyrus extraplugins
- full_papyrus_http.psf all papyrus plugins available on the SVN
- plugins_http.psf all papyrus plugins
- tests_http.psf Junit and other test plugins (mandatory for developers)
- last versions of the psf files for Papyrus/trunk using svn+ssh for commiters:
- build_svn_ssh.psf release engineering projects
- extraplugins_svn_ssh.psf all papyrus extraplugins
- full_papyrus_svn_ssh.psf all papyrus plugins available on the SVN
- plugins_svn_ssh.psf all papyrus plugins
- tests_svn_ssh.psf Junit and other test plugins (mandatory for developers)
How to update the script generating the psf files.
The script is located on build.eclipse.org in /opt/public/modeling/mdt/papyrus/create_psf_files.sh.
- To modify it :
- download this project with Eclipse http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/readme/
- modify it and commit it on the SVN
- log you on hudson
- execute the script /opt/public/modeling/mdt/papyrus/update_psf_files_script.sh. This script allows to download and "install" the last version of the scripts located in trunk/readme/script (so it updates itself too)
How to update the psf files provided in /trunk/readme.
Coming soon
Retrieve configuration files
The Papyrus Code Templates and Java Formatter files are available under the Papyrus repository in the plugin org.eclipse.papyrus.doc under the folder "templates"
FAQ How do I control the Java formatter
FAQ How can templates make me the fastest coder ever
Checkstyle : available soon
The note explains how to install the templates in your environment.
Papyrus Architecture
- Papyrus architecture is explained here: Papyrus Architecture
Papyrus Generation
- Papyrus generation mechanism is explained here : Papyrus Developer Guide/Papyrus diagram generation
Papyrus Code Standards
- Java Doc - every class, method and field including private ones should be documented with Java Doc
- No abbreviations - the class, methods and variables should have meaningful names
- Formatting - the code should be formatted in accordance with format templates
- Compile - the modified code and other plugins should be compilable. Be sure to use Java 1.5 code compatibility. Check other plugins that could be influenced before commiting!
- Standard Java Rules coding - Unless specified differently, the Java Standard Coding rules should be applied : no abbreviations, variables starting with lower case; class and types with upper case; Composed name separated with upper case; no underscore in names; ...
- In case of doubt - check existing code from those following the rules :-)
Papyrus Coding guidelines
A few points may be a little tricky when coding for Papyrus. Among them :
Papyrus Plugin Naming Scheme and Folders Structure
- Papyrus plugins naming scheme and folder structure used to locate and name plugins is described here: Papyrus_Plugin_Naming_Scheme
Structure and behavior of papyrus
- Presentation of the papyrus stucture and the behavior of some parts Papyrus Developer Guide/Papyrus Structure Behavior
Papyrus Command Execution, History, Undo/Redo
- This first document describes the usage of editing domains and gmf/gef/emf commands. See this detailed article Papyrus Developer Guide/Editing Domains and Commands.
- This second document tries to explain how the differents Eclipse Command frameworks work and how they are related. It also explains how commands should be executed in Papyrus, in order to have correct undo/redo.
- http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments/architecture/commandExecution.doc
- Following UML model with code reverse can also be useful:
- http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments//architecture/CommandStackFramework.di
- http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments//architecture/CommandStackFramework.notation
- http://dev.eclipse.org/svnroot/modeling/org.eclipse.mdt.papyrus/trunk/doc/DevelopperDocuments//architecture/CommandStackFramework.uml
How To ...
Commit, Report Bugs, patchs (Code Contributing)
- How To - related to reporting bugs, patching, commit, ... Papyrus Developer Guide/How To- Code Contributing
Papyrus Code Examples
- How to - Related to Papyrus code,Papyrus Developer Guide/How To Code Examples
Papyrus Log
- Papyrus Log is explained here Papyrus Developer Guide/Papyrus Log
Papyrus Editors
Currently Papyrus provides 2 editors kinds : Diagrams and Table. How to add your own editor kind is explained here Papyrus Developper Guide/How to - Add your own editor in Papyrus
Papyrus Build Process
- Papyrus build process on Athena is explained here Papyrus Developer Guide/Build Process.
New plugin Submition Process
New plugin should follow the submition process describe here: Papyrus New Plugin Submission Process