Standards

Contents
Info
Bugs
Docs
Source
Email
Download
Developer

Developer
Projects
Reuse
Policy
Standards

Example Package Layout

Here we describe an example layout for a GJT package.

   A recommended layout might be:
      /org/gjt/joe/myed/                  <-- The "MyEditor" application.
      /org/gjt/joe/myed/doc               <-- This tree will get copied to the top.
      /org/gjt/joe/myed/doc/README        <-- This file will get copied to the top.
      /org/gjt/joe/myed/doc/License
      /org/gjt/joe/myed/doc/Install
      /org/gjt/joe/myed/MyEditor.java     <-- The "MyEditor" main() Class.
      /org/gjt/joe/myed/*.java            <-- The remaining Java sources

   And if joe had a set of utility classes that he used frequently
   he might have another package such as:
      /org/gjt/joe/util/                  <-- The "utilities" package.
      /org/gjt/joe/util/...sources...     <-- The "utilities" sources.
      /org/gjt/joe/util/doc               <-- This tree will get copied to the top. (*)
      /org/gjt/joe/util/doc/README        <-- This file will get copied to the top. (*)
      /org/gjt/joe/util/doc/...docs...
      /org/gjt/joe/util/doc/manual
      /org/gjt/joe/util/doc/manual/...manual-files...

   * When this package is built as a standalone package, these will be copied
     to the top. However, when checked out as a dependency of another package,
     it will not, as that would overwrite the main package's files. In the 
     dependent case, these files are left in the subtree.