From 356a9d73e00153e602df51c6519bb72affc4533a Mon Sep 17 00:00:00 2001 From: Guillem Jover Date: Mon, 15 May 2023 19:29:20 +0200 Subject: [PATCH] MT#57448 Add or rework missing require POD sections For some modules the section was named LICENCE instead of LICENSE. Add DESCRIPTION, AUTHOR and LICENSE sections when missing. Unify LICENSE section contents. Warned-by: perlcritic Fixes: Documentation::RequirePodSections Change-Id: I7e9e2ce9a3e4ae4ab216ac87635d1cdc78c6998c --- README | 2 +- lib/Sipwise/Base.pm | 40 ++++++++++++++-------------------- lib/Sipwise/Boilerplate.pm | 32 ++++++++++++++++++++++++--- lib/Sipwise/CodingStandards.pm | 17 +++++++++++++++ 4 files changed, 63 insertions(+), 28 deletions(-) diff --git a/README b/README index d7221ea..36b71e4 100644 --- a/README +++ b/README @@ -14,7 +14,7 @@ See L. See distribution meta file. -=head1 LICENCE +=head1 LICENSE This software is Copyright © 2013 by Sipwise GmbH, Austria. diff --git a/lib/Sipwise/Base.pm b/lib/Sipwise/Base.pm index 7eedbcc..c60ad9d 100644 --- a/lib/Sipwise/Base.pm +++ b/lib/Sipwise/Base.pm @@ -104,27 +104,19 @@ L, L, Ingy's L, L Lars Dieckow C<< >> -=head1 LICENCE - -This software is Copyright © 2013 by Sipwise GmbH, Austria. - -This program is free software; you can redistribute it -and/or modify it under the terms of the GNU General Public -License as published by the Free Software Foundation; either -version 3 of the License, or (at your option) any later -version. - -This program is distributed in the hope that it will be -useful, but WITHOUT ANY WARRANTY; without even the implied -warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR -PURPOSE. See the GNU General Public License for more -details. - -You should have received a copy of the GNU General Public -License along with this package; if not, write to the Free -Software Foundation, Inc., 51 Franklin St, Fifth Floor, -Boston, MA 02110-1301 USA - -On Debian systems, the full text of the GNU General Public -License version 3 can be found in the file -F. +=head1 LICENSE + +Copyright © 2013-2023 Sipwise GmbH, Austria. + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . diff --git a/lib/Sipwise/Boilerplate.pm b/lib/Sipwise/Boilerplate.pm index 53eb380..37c7449 100644 --- a/lib/Sipwise/Boilerplate.pm +++ b/lib/Sipwise/Boilerplate.pm @@ -11,8 +11,13 @@ Sipwise::Boilerplate - a template for new code =head1 SYNOPSIS -Copy the following text, outdent it, save to a new file, then fill it in. Delete the C<=for author> POD sections after -you are done with them. +This module describes the module boilerplate to be used as a template +when creating new Sipwise modules. + +=head1 DESCRIPTION + +Copy the following text, outdent it, save to a new file, then fill it in. +Delete the C<=for author> POD sections after you are done with them. package Something::Or::Other 1.000; use Sipwise::Base; @@ -185,6 +190,27 @@ you are done with them. Your Name C<< >> - =head1 LICENCE + =head1 LICENSE restricted + +=head1 AUTHOR + +Sipwise Developers + +=head1 LICENSE + +Copyright © 2013-2023 Sipwise GmbH, Austria. + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . diff --git a/lib/Sipwise/CodingStandards.pm b/lib/Sipwise/CodingStandards.pm index ad5fcf0..0337345 100644 --- a/lib/Sipwise/CodingStandards.pm +++ b/lib/Sipwise/CodingStandards.pm @@ -120,3 +120,20 @@ Install L and L >> + +=head1 LICENSE + +Copyright © 2013-2023 Sipwise GmbH, Austria. + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .