Pod::W...icated(3pm)

πŸ“¦
version 1.23 Β· 2 versions
  • 1.23 Β· debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 1.22 Β· ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

okay so bestie, welcome to Pod::Weaver::Section::Legal::Complicated β€” it's a Perl module, it lives in the User Contributed Perl Documentation, and it's here to handle the legal side of your distro without you having to hand-write a single copyright line. πŸ’…


🌸 NAME 🌸

Pod::Weaver::Section::Legal::Complicated β€” different authors, copyright holders, and licenses for each module. yes really, per module. it's giving ✨customization✨


πŸŽ€ VERSION πŸŽ€

version 1.23 β€” that's the vibe check, and it passed. βœ…


πŸ¦‹ SYNOPSIS πŸ¦‹

drop this into your weaver.ini and you're literally done:

[Legal::Complicated]

that's it. that's the whole setup. iconic behavior honestly.


πŸ’– DESCRIPTION πŸ’–

so here's the tea πŸ“: this plugin is made for distributions that have several files, and each one might have different authors, copyright owners, and licenses. like, you're not gonna force one blanket license on a whole mixed bag of files, that would be a mess.

It goes looking for these values inside comments in the source code β€” and yes, it analyzes them through a ppi_document β€” with this exact form:

# AUTHOR:  John Doe <john.doe@otherside.com>
# AUTHOR:  Mary Jane <mary.jane@thisside.com>
# OWNER:   2001-2005 University of Over Here
# OWNER:   2012 Mary Jane
# LICENSE: GPL_3

and that little example right there would generate this POD for you:

=head2 AUTHORS

John Doe <john.doe@otherside.com>
Mary Jane <mary.jane@thisside.com>

=head2 COPYRIGHT

This software is copyright (c) 2001-2005 by University of Over Here, and 2012 by Mary Jane.

This software is available under The GNU General Public License, Version 3, June 2007.

look at that. clean. ✨

ngl, the important thing to clock here: this plugin makes a distinction between the authors (whoever actually wrote the code) and the actual copyright owners (which could totally be the person who paid them to write it). different roles, different credit, we don't conflate them. 🫢

and fr fr, the author of this plugin says: "I am not a lawyer myself, any feedback on better ways to deal with this kind of situations is most welcome." so if you know legal stuff, hmu, they want the input. πŸ’Œ


πŸ‘‘ ATTRIBUTES πŸ‘‘

add_dist_license

if this one is true, it will also add the distribution license to each of the files. defaults to false. so like, off unless you say otherwise, bestie.

sets the heading level for the legal section. defaults to 1.


⭐ NOTE ON DEPENDENCIES ⭐

okay so this plugin is dependent on the Software::License::* module of the license that's being used. and since it is not feasible to list them all, only Software::License is listed as a dependency β€” and that's a dependency of the distribution, even though it's not actually used directly. yes, that's a little cursed, but that's what it says. πŸ™ˆ


πŸ’œ AUTHOR πŸ’œ

CarnΓ« Draug <cdraug@cpan.org> πŸ’Œ


This software is Copyright (c) 2013-2017 by CarnΓ« Draug.

This is free software, licensed under:

The GNU General Public License, Version 3, June 2007

and that's the whole page, bestie! πŸŽ€ this was perl v5.34.0, dated 2022-06-16, and it's the Pod::W...icated(3pm) page β€” go forth and license responsibly, mwah πŸ’…βœ¨