OganizationConventions » History » Version 3
J. Wienke, 10/13/2011 11:29 AM
| 1 | 1 | J. Moringen | h1. OganizationConventions |
|---|---|---|---|
| 2 | 1 | J. Moringen | |
| 3 | 1 | J. Moringen | _These conventions are in brainstorming staging. Feel free to add any thoughts or suggestions._ |
| 4 | 1 | J. Moringen | |
| 5 | 1 | J. Moringen | h2. Naming |
| 6 | 1 | J. Moringen | |
| 7 | 3 | J. Wienke | * Do not include artifacts of the current communication pattern for one type. I.e. if you currently send events of images, your type must not be @ImageEvent@, but solely @Image@, as the @Image@ type might later be reused in an RPC communication. |
| 8 | 1 | J. Moringen | |
| 9 | 1 | J. Moringen | h2. Directory Layout |
| 10 | 1 | J. Moringen | |
| 11 | 1 | J. Moringen | The current policy for filenames of data definitions in RST is as follows: |
| 12 | 1 | J. Moringen | * The directory (relative to the "proto" directory in the project root) in which the proto-file resides should match the package name with all "."s replaced with "/"s |
| 13 | 1 | J. Moringen | * The filename should match the name of the "primary" message definition (with ".proto" appended) |
| 14 | 1 | J. Moringen | * There should only be one "primary" message definition in each proto-file |
| 15 | 2 | J. Wienke | ** Groups of related messages should reside in individual files and refer to each other using @import@ |
| 16 | 2 | J. Wienke | * directory names are all lowercase |
| 17 | 1 | J. Moringen | |
| 18 | 1 | J. Moringen | h2. Rationale |
| 19 | 1 | J. Moringen | |
| 20 | 1 | J. Moringen | * Facilitate easy documentation and reuse via @import@ |
| 21 | 1 | J. Moringen | * Data definitions can be treated as resources with unique URLs |
| 22 | 1 | J. Moringen | ** These URLs can be derived from a qualified message name |
| 23 | 1 | J. Moringen | E.g. @.rst.ImageMessage -> https://code.cor-lab.org/svn/rst/trunk/proto/rst/ImageMessage.proto@ |