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 "Components Page Conventions"
(→Project Rows) |
(→Project Rows) |
||
Line 22: | Line 22: | ||
Each regular row of the table is a project. | Each regular row of the table is a project. | ||
− | * | + | * '''type''' of project |
− | * | + | ** ''Interface'' - this project defines the interface for the component separately from its implementation |
+ | ** ''Impl.'' - implementation | ||
+ | ** ''Alt. Impl'' - one of N alternative implementations of the component interface | ||
+ | ** ''Test'' - unit test project | ||
+ | ** ''Misc'' - misc supporting implementation project | ||
+ | * '''project name''' (Second-from-left-most column) | ||
** If the project is shared with other components the word "(shared)" will appear after the project name | ** If the project is shared with other components the word "(shared)" will appear after the project name | ||
* '''Dep.''' (Dependencies) - wiki page of non-Higgins libraries (e.g. JARs) that this component depends on to build and run | * '''Dep.''' (Dependencies) - wiki page of non-Higgins libraries (e.g. JARs) that this component depends on to build and run |
Revision as of 12:07, 10 December 2008
{{#eclipseproject:technology.higgins}}
Table Format
The tables on the Components page uses these templates:
- Template:HigCompTblHead2 - table header
- Template:HigCompTblSec2 - grey table section rows
- Template:HigCompTblRow2 - Eclipse project row
- Template:HigCompTblRow2Wiki - Eclipse project row with regular wiki page
- Template:HigCompTblRow2Note - Eclipse project row with "note" wiki page
Table Header
Left-most column
- <Component Name> - wiki page describing this Component. Should follow Component Description Template
- bugzilla shortcuts - create, open, closed
Table Section Row
Left-most column
- Indicates the runtime environment supported by the project-rows in this section (e.g. Java 1.4 or Adobe Flex, etc.)
Project Rows
Each regular row of the table is a project.
- type of project
- Interface - this project defines the interface for the component separately from its implementation
- Impl. - implementation
- Alt. Impl - one of N alternative implementations of the component interface
- Test - unit test project
- Misc - misc supporting implementation project
- project name (Second-from-left-most column)
- If the project is shared with other components the word "(shared)" will appear after the project name
- Dep. (Dependencies) - wiki page of non-Higgins libraries (e.g. JARs) that this component depends on to build and run
- Repository - svn link to the SVN source files and viewsvn link. Note
- Use either the https link given, or substitute svn+ssh for https as the svn URL in order to access the code for a project
- Downloads - link to the mostly recently generated nightly on build.eclipse.org [Soon: this page will also include all stable builds]
- Test Status - For each of the java sub-projects of each Component listed in all of these tables there exists a second project a sister ".test" project exists containing unit tests. These tests are [well, will soon be] automatically run during the nightly build process. This cell should contain a status word related to these tests:
- none - no sister ".test" project exists
- minimal - a few unit tests exist in the ".test" project
- good - reasonable coverage of functionality exists in the ".test" project
- First check-in [MANDATORY] - The first branch that contained this project or file. E.g. if the table or release build that contained this project/file was "B-1-0-0" then this column entry would read "B-1-0-0".
- Most recent [MANDATORY] - The most recent branch that contains this project or file. E.g. if the most recent stable or release build were "B-1-0-0" then if this project/file were a part of this build then this column entry would read "B-1-0-0".
- Owner - email of the owner of this component
Old Template
- Old Components Page Conventions using older templates