Foswiki on GitHub is open for business! Next release meeting: Monday September 29, 1300Z

Item11467: Need better documentation and handling of Perl dependencies

Priority: CurrentState: AppliesTo: Component: WaitingFor:
Normal Closed Engine Documentation  
Recently revised documentation no longer has the list of Perl Module dependencies, and refers installers to the lib/DEPENDENCIES file. This minimizing of dependencies leaves users with semi-functional systems. If a default core feature is dependent upon a perl module, it really ought to be clearly documented.

  • Restore the Perl Modules list to System/SystemRequirements
    • omit any modules shipped with Foswiki
    • "required" should be set for any key default features like Wysiwyg, compare, email.

  • The Digest::SHA1 is deprecated, but still needed by the core/lib/CPAN/lib/Cache/FileBackend.pm file. Since it's required by a CPAN module we already ship, add this to the lib/CPAN/lib directory.

  • This information should also be available in the INSTALL guide we ship in the root directory. Include it as an appendix.

-- GeorgeClark - 23 Jan 2012

 

ItemTemplate edit

Summary Need better documentation and handling of Perl dependencies
ReportedBy GeorgeClark
Codebase 1.1.4, trunk
SVN Range
AppliesTo Engine
Component Documentation
Priority Normal
CurrentState Closed
WaitingFor
Checkins Foswikirev:13797 Foswikirev:13798 Foswikirev:13799
TargetRelease patch
ReleasedIn 1.1.5
CheckinsOnBranches Release01x01 trunk
trunkCheckins Foswikirev:13797 Foswikirev:13799
Release01x01Checkins Foswikirev:13798
Topic revision: r6 - 11 Apr 2012, GeorgeClark
 
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement. Creative Commons License