dependency on external jar file for admin js minification needs better documentation
|Reported by:||gabrielhurley||Owned by:||gabrielhurley|
|Severity:||Keywords:||admin js compress|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
In revision  jezdez added contrib/admin/media/js/compress.py, which is very handy but is also dependent on the developer having downloaded and installed Google's Closure Compiler. That's further complicated by the fact that Closure Compiler relies on Java 6 (or Java 1.6 on Mac OS X, which was not the default shipped version of Java until Snow Leopard).
While I eventually figured out what compiler it was looking for from the help text on the -c flag ( "path to closure compiler jar file"), having proper documentation of the external requirement, where to download the compiler from, a note about the potential trouble with Mac OS X, etc. would be more developer-friendly. Comments in the source and/or improved help text are probably the place to add the notes.
I'll write up a patch a bit later.
Change History (6)
comment:1 Changed 4 years ago by russellm
- Component changed from Contrib apps to Documentation
- Needs documentation unset
- Needs tests unset
- Patch needs improvement unset
- Triage Stage changed from Unreviewed to Accepted
Changed 4 years ago by gabrielhurley
comment:4 Changed 4 years ago by jezdez
- Resolution set to fixed
- Status changed from assigned to closed