Skip to content

Commit

Permalink
Issue #4111: Mention that HTML::Scrubber has adaptions
Browse files Browse the repository at this point in the history
try to improve the markup by marking commands and file names
  • Loading branch information
bschmalhofer committed Jan 28, 2025
1 parent 8b1c32c commit e44f74d
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions Kernel/cpan-lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ All of these modules are implemented in pure Perl.
License information of the bundled modules can be found in the
[COPYING-Third-Party](../../COPYING-Third-Party) file.

The original list of the bundled distributions is maintained in the module Kernel::System::Environment. Please keep
that list up to date when upgrading or adding distributions. The list from Kernel::System::Environment is also used by
bin/otobo.CheckModules.pl. That command can be used to generate a cpanfile for the bundled modules.
The generated cpanfile can then be used for updating Kernel/cpan-lib.
The original list of the bundled distributions is maintained in the module `Kernel::System::Environment. Please keep
that list up to date when upgrading or adding distributions. The list from `Kernel::System::Environment` is also used by
the command *bin/otobo.CheckModules.pl*. That command can be used to generate a cpanfile for the bundled modules.
The generated cpanfile can then be used for updating *Kernel/cpan-lib*.
But that task is not trivial. So here is an exemplar workflow:

### Preparation for both quick update and complete regeneration
Expand Down Expand Up @@ -63,10 +63,11 @@ The reason why specific files are not included in the bundle is not always evide
find . \( -name "*.pl" \) -delete # just because this is the tradition
find . -type d -empty -delete # empty dirs are not needed, usually dirs with documentation only

### Add files that do no originate from CPAN.
### Add files that do no originate from CPAN or are modified by OTOBO

cp -r Devel/REPL local/lib/perl5/Devel # the plugins Devel::REPL::Plugin::OTOBO is not on CPAN
cp -r Plack local/lib/perl5/Plack # the Plack plugins are not on CPAN
cp -r Devel/REPL local/lib/perl5/Devel # the plugins Devel::REPL::Plugin::OTOBO is not on CPAN
cp -r Plack local/lib/perl5/Plack # the Plack plugins are not on CPAN
cp -r HTML/Scrubber.pm local/lib/perl5/HTML/Scrubber # with OTOBO specific modifications

### Install missing modules

Expand All @@ -93,7 +94,7 @@ Clean up again when module were installed

### Finalize

Copy new or changed files into Kernel/cpan-lib. Remove no longer needed files. Make sure that
Copy new or changed files into *Kernel/cpan-lib*. Remove no longer needed files. Make sure that
the changes are submitted to git.

diff -r . local/lib/perl5/ | grep -v cpanfile | grep -v README.md # the goal is to see only 'local'
Expand Down

0 comments on commit e44f74d

Please sign in to comment.