This repository is private.
All pages are served over SSL and all pushing and pulling is done over SSH.
No one may fork, clone, or view it unless they are added as a member.
Every repository with this icon (
) is private.
Every repository with this icon (
This repository is public.
Anyone may fork, clone, or view it.
Every repository with this icon (
) is public.
Every repository with this icon (
Hongli Lai (Phusion) (author)
Tue Apr 29 15:05:10 -0700 2008
passenger / DEVELOPERS.TXT
| 58632cb6 » | Hongli Lai (Phusion) | 2008-03-18 | 1 | = Developers information | |
| 2 | |||||
| 3 | == Required software | ||||
| 4 | |||||
| 5 | The tests need the following software installed: | ||||
| 6 | |||||
| 7 | * All the usual Passenger dependencies. | ||||
| 8 | * Ruby on Rails >= 2.0.1 | ||||
| 9 | * rspec >= 1.1.2 | ||||
| 10 | * mime-types >= 1.15 | ||||
| 11 | |||||
| 12 | The following software is optional: | ||||
| 13 | |||||
| 14 | * RDoc, for generating HTML Ruby API documentation | ||||
| 15 | * Doxygen, for generating HTML C++ API documentation | ||||
| 16 | * dot (part of Graphviz), for generating diagrams in HTML API documentation | ||||
| 17 | * The font "Bitstream Vera Sans", used in the class diagrams. See http://www.gnome.org/fonts | ||||
| 18 | * AsciiDoc >= 8.2.5, for converting various doc/*.txt documents to HTML | ||||
| 19 | |||||
| 20 | == Compiling Passenger | ||||
| 21 | |||||
| 22 | Run the following command to compile everything: | ||||
| 23 | |||||
| 24 | rake | ||||
| 25 | |||||
| 26 | == Tests | ||||
| 27 | |||||
| 28 | Run all tests: | ||||
| 29 | |||||
| 30 | rake | ||||
| 31 | |||||
| 32 | Run just the tests for the Apache 2 module: | ||||
| 33 | |||||
| 34 | rake test:apache2 | ||||
| 35 | |||||
| 36 | Run just the unit tests for the Ruby spawn server: | ||||
| 37 | |||||
| 38 | rake test:ruby | ||||
| 39 | |||||
| 40 | Run just the integration tests: | ||||
| 41 | |||||
| 42 | rake test:integration | ||||
| 43 | |||||
| 44 | *Note*: some tests, such as the ones that test privilege lowering, require | ||||
| 45 | root privileges. Those will only be run if Rake is run as root. | ||||
| 46 | |||||
| 47 | == Documentation | ||||
| 48 | |||||
| 49 | Various developer documents can be found in 'doc/*.html'. | ||||
| 50 | |||||
| 51 | The Ruby part's API reference is located in 'doc/rdoc/'. | ||||
| 52 | The C++ part's API reference is located in 'doc/cxxapi/'. | ||||






