This repository was archived by the owner on Aug 2, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
PackageNaming
Johan Brichau edited this page Mar 26, 2015
·
1 revision
Below a rough EBNF grammar of how Seaside and Monticello expect packages and versions to be named (no spaces allowed anywhere):
Package = PackageName VersionInfo
PackageName = Name "-" [ Purpose "-" ] [ Platform "-" ] Rest
VersionInfo = { "." Branch } "-" Author "." Version
| Token | Required | Explanation | Examples |
|---|---|---|---|
| Name | mandatory | The top level package name |
Seaside, Scriptaculous, ... |
| Purpose | optional | Present for tests or examples only |
Tests, Examples, ... |
| Platform | optional | Present for platform specific code only |
Pharo, GemStone, ... |
| Rest | mandatory | The second level package name (avoid $- in the name) |
Core, Canvas, ... |
The package ...
-
Seaside-Canvascontains he canvas implementation. -
Seaside-Pharo-Canvascontains the platform specific code of the canvas implementation. -
Seaside-Examples-Canvascontains example code showing of the canvas implementation. -
Seaside-Tests-Canvascontains the tests for the canvas implementation. -
Seaside-Tests-Pharo-Canvascontains the platform specific tests of the canvas implementation.
| Token | Required | Explanation | Examples |
|---|---|---|---|
| Branch | zero-or-more | The branch name starts with a lowercase letter and should not contain hyphens ( |
issue123, configcleanup, ... |
| Author | mandatory | The author initials are a short sequence of lowercase letters. |
lr, jf, pmm, ... |
| Version | mandatory | The version numbering starts at 1 and is sequentially counting upwards with every commit. |
1, 2, 3, ... |
The version ...
-
Seaside-Core-pmm.2is the second version of the packageSeaside-Corecommitted bypmm. -
Seaside-Core.configcleanup-jf.3is the third version of the packageSeaside-Corecommitted byjfinto theconfigcleanupbranch. -
Seaside-Core.configcleanup.extraspeedup-lr.69is the version 69 of the packageSeaside-Corecommitted bylr, and is possibly a merge of the branchesconfigcleanupandextraspeedup.