Skip to content

Commit f0a44ff

Browse files
committed
documentation update
1 parent edbc547 commit f0a44ff

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,10 @@ The following compile-time variable can tighten further the security of PEB.
155155
PEB can also use any Perl on PATH.
156156

157157
## Preparing a Perl Distribution for PEB
158-
Sometimes it is important to minimize the size of the relocatable (or portable) Perl distribution used for a PEB-based application. ``{PEB_binary_directory}/sdk/compactor.pl`` script is one solution to this problem. It scans all Perl scripts in the ``{PEB_binary_directory}/resources/app`` directory, finds all their dependencies and copies them in a new ``{PEB_binary_directory}/perl/lib`` folder; a new ``{PEB_binary_directory}/perl/bin`` is also created. The original ``bin`` and ``lib`` folders are saved as ``{PEB_binary_directory}/perl/bin-original`` and ``{PEB_binary_directory}/perl/lib-original`` respectively. ``bin-original`` and ``lib-original`` directories should be manually archived or removed.
158+
Sometimes it is important to minimize the size of the relocatable (or portable) Perl distribution used for a PEB-based application. ``{PEB_binary_directory}/sdk/compactor.pl`` script is one solution to this problem. It finds all dependencies of the Perl scripts in the ``{PEB_binary_directory}/resources/app`` directory and copies them in a new ``{PEB_binary_directory}/perl/lib`` folder; a new ``{PEB_binary_directory}/perl/bin`` is also created. The original ``bin`` and ``lib`` folders are saved as ``{PEB_binary_directory}/perl/bin-original`` and ``{PEB_binary_directory}/perl/lib-original`` respectively. These directories should be manually archived or removed.
159+
159160
``compactor.pl`` should be started using ``{PEB_binary_directory}/compactor.sh`` on a Linux and Mac machines and ``{PEB_binary_directory}/compactor.cmd`` on a Windows machine to ensure that only the Perl distribution used by PEB is going to start ``compactor.pl``. This is necessary to avoid dependency mismatches with any other Perl on PATH.
161+
160162
``compactor.pl`` relies on ``Module::ScanDeps`` and ``File::Copy::Recursive`` CPAN modules, which are located in the ``{PEB_binary_directory}/sdk/lib`` folder.
161163

162164
## Supported Perl Script Types

sdk/compactor.pl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#! ././perl/bin/perl
1+
#!././perl/bin/perl
22

33
use strict;
44
use warnings;

0 commit comments

Comments
 (0)