OganizationConventions » History » Version 2
J. Wienke, 10/13/2011 11:24 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 | 1 | J. Moringen | TBD |
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@ |