LICENSE misc/gpl-3.0.txt @@ -2,6 +2,8 @@ Development camps: better development environments http://www.devcamps.org/ Version 3.00 +Copyright (C) 2006-2009 End Point Corporation +Released under GPLv3+ Perl and module requirements: README @@ -1,7 +1,5 @@ #!/usr/local/bin/perl -# camp information getter/setter - use strict; use warnings; @@ -136,3 +134,37 @@ if (!$set_attribute) { } @requested_fields; print "\n" unless $opt{'no-newline'}; } + + +=pod + +=head1 NAME + +camp-info - camp information getter/setter + +=head1 VERSION + +3.00 + +=head1 AUTHOR + +Ethan Rowe E<lt>ethan@endpoint.comE<gt> and other contributors + +=head1 LICENSE AND COPYRIGHT + +Copyright (C) 2006-2009 End Point Corporation, http://www.endpoint.com/ + +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: http://www.gnu.org/licenses/ + +=cut bin/camp-info @@ -116,3 +116,51 @@ sub file_lint { } find (\&file_lint, '.'); + + +=pod + +=head1 NAME + +camp-lint - check for possible problems with a camp + +=head1 DESCRIPTION + +This checks for: + +=over + +=item * absolute symbolic link targets + +=item * symbolic links that point outside of the camp root + +=item * files and directories that aren't world-readable but should be + +=back + +=head1 VERSION + +3.00 + +=head1 AUTHOR + +Jon Jensen E<lt>ethan@endpoint.comE<gt> and other contributors + +=head1 LICENSE AND COPYRIGHT + +Copyright (C) 2006-2009 End Point Corporation, http://www.endpoint.com/ + +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: http://www.gnu.org/licenses/ + +=cut bin/camp-lint @@ -1,7 +1,5 @@ #!/usr/local/bin/perl -# new camp creation script - use strict; use warnings; use Getopt::Long; @@ -145,3 +143,36 @@ however is appropriate. END } + +=pod + +=head1 NAME + +mkcamp - create a new camp + +=head1 VERSION + +3.00 + +=head1 AUTHOR + +Ethan Rowe E<lt>ethan@endpoint.comE<gt> and other contributors + +=head1 LICENSE AND COPYRIGHT + +Copyright (C) 2006-2009 End Point Corporation, http://www.endpoint.com/ + +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: http://www.gnu.org/licenses/ + +=cut bin/mkcamp @@ -23,3 +23,36 @@ foreach my $camp (glob "$ENV{HOME}/camp*") { symlink($camp,$link_name); }; + +=pod + +=head1 NAME + +mkcampsymlinks - create symlinks with camp information + +=head1 VERSION + +3.00 + +=head1 AUTHOR + +David Christensen E<lt>ethan@endpoint.comE<gt> and other contributors + +=head1 LICENSE AND COPYRIGHT + +Copyright (C) 2006-2009 End Point Corporation, http://www.endpoint.com/ + +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: http://www.gnu.org/licenses/ + +=cut bin/mkcampsymlinks @@ -61,11 +61,16 @@ if ($show) { exec($cmd); + =pod =head1 NAME -mysql_camp -- a utility for invoking the mysql client for a camp mysql instance +mysql_camp - invoke the mysql client for a camp MySQL instance + +=head1 VERSION + +3.00 =head1 SYNOPSIS @@ -132,8 +137,25 @@ The socket, port, hostname, password, etc. are expected to reside in the relevan file that is easily readable and understandable. The utility makes a best guess at connecting to the database based on the contents of that file. If the file doesn't exist, it will throw an error. -=head1 CREDITS +=head1 AUTHOR + +Ethan Rowe E<lt>ethan@endpoint.comE<gt> and other contributors + +=head1 LICENSE AND COPYRIGHT + +Copyright (C) 2006-2009 End Point Corporation, http://www.endpoint.com/ + +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. -Original author: Ethan Rowe (ethan@endpoint.com) June 2007 +You should have received a copy of the GNU General Public License +along with this program. If not, see: http://www.gnu.org/licenses/ =cut bin/mysql_camp @@ -1,7 +1,5 @@ #!/usr/local/bin/perl -# camp psql helper - use strict; use warnings; use lib '/home/camp/lib'; @@ -37,3 +35,37 @@ $ENV{PGUSER} ||= $conf->{db_default_user}; $ENV{PGDATABASE} ||= $conf->{db_default_database}; exec '/usr/bin/psql', '-p', $port, @ARGV; + + +=pod + +=head1 NAME + +psql_camp - invoke the psql client for a camp PostgreSQL instance + +=head1 VERSION + +3.00 + +=head1 AUTHOR + +Jon Jensen E<lt>ethan@endpoint.comE<gt> and other contributors + +=head1 LICENSE AND COPYRIGHT + +Copyright (C) 2006-2009 End Point Corporation, http://www.endpoint.com/ + +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: http://www.gnu.org/licenses/ + +=cut bin/psql_camp @@ -1,7 +1,5 @@ #!/usr/local/bin/perl -# camp restart script - use strict; use warnings; use Getopt::Long; @@ -104,3 +102,37 @@ for my $camp_number (@camp_numbers) { } exit 0; + + +=pod + +=head1 NAME + +re - restart one or more camp services + +=head1 VERSION + +3.00 + +=head1 AUTHOR + +Ethan Rowe E<lt>ethan@endpoint.comE<gt> and other contributors + +=head1 LICENSE AND COPYRIGHT + +Copyright (C) 2006-2009 End Point Corporation, http://www.endpoint.com/ + +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: http://www.gnu.org/licenses/ + +=cut bin/re @@ -87,11 +87,16 @@ if ($showpod) { exit; + =pod =head1 NAME -refresh-camp -- an utility for refreshing various components within your camp +refresh-camp - refresh various components within a camp + +=head1 VERSION + +3.00 =head1 SYNOPSIS @@ -156,10 +161,25 @@ through the copy-paths.yml config for your camp type to be updated appropriately via rsync) from the canonical source. This probably means that any custom files you had in these paths would be lost. -=head1 CREDITS +=head1 AUTHOR + +Ethan Rowe E<lt>ethan@endpoint.comE<gt> and other contributors + +=head1 LICENSE AND COPYRIGHT + +Copyright (C) 2006-2009 End Point Corporation, http://www.endpoint.com/ + +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. -Original author: Ethan Rowe (ethan@endpoint.com) +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. -July, 2007 +You should have received a copy of the GNU General Public License +along with this program. If not, see: http://www.gnu.org/licenses/ =cut bin/refresh-camp @@ -1,7 +1,5 @@ #!/usr/local/bin/perl -# remove camp script - use strict; use warnings; use lib '/home/camp/lib'; @@ -37,3 +35,37 @@ print "Removing entry from master camp database\n"; unregister_camp($conf{number}); print "Done deleting $conf_hash->{name}\n"; + + +=pod + +=head1 NAME + +rmcamp - remove a camp + +=head1 VERSION + +3.00 + +=head1 AUTHOR + +Ethan Rowe E<lt>ethan@endpoint.comE<gt> and other contributors + +=head1 LICENSE AND COPYRIGHT + +Copyright (C) 2006-2009 End Point Corporation, http://www.endpoint.com/ + +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: http://www.gnu.org/licenses/ + +=cut bin/rmcamp @@ -1,11 +1,5 @@ #!/usr/local/bin/perl -# revised with-camp helper; obsoletes psql_camp and with-camp both. -# we could alias psql_camp to with-camp psql - -# also enables pgdump, etc of camp database without further tool -# creation/modification. - use strict; use warnings; use lib '/home/camp/lib'; @@ -53,3 +47,43 @@ $ENV{PATH} = "$ENV{PATH}:$ENV{HOME}/camp$camp/bin"; $ENV{CAMP} = $camp; exec @ARGV; + + +=pod + +=head1 NAME + +with-camp - wrapper to run another command with camp awareness + +=head1 VERSION + +3.00 + +=head1 DESCRIPTION + +This utility sets necessary environment variables so that you can use +pg_dump and similar programs without needing a separate wrapper like +psql_camp for each. In fact psql_camp could be replaced with C<with-camp psql>. + +=head1 AUTHOR + +David Christensen E<lt>ethan@endpoint.comE<gt> and other contributors + +=head1 LICENSE AND COPYRIGHT + +Copyright (C) 2006-2009 End Point Corporation, http://www.endpoint.com/ + +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: http://www.gnu.org/licenses/ + +=cut bin/with-camp @@ -707,7 +707,11 @@ sub env_variables { =head1 NAME -Camp::Config -- Standard module for determining operating environment and configuration settings +Camp::Config - module for determining operating environment and configuration settings + +=head1 VERSION + +3.00 =head1 DESCRIPTION @@ -1192,10 +1196,29 @@ like B<chcamp>. =back -=head1 CREDITS +=head1 BUGS AND LIMITATIONS + +This module has tests. It also probably has bugs. It is, after all, software. + +=head1 AUTHOR + +Ethan Rowe E<lt>ethan@endpoint.comE<gt> and other contributors + +=head1 LICENSE AND COPYRIGHT + +Copyright (C) 2006-2009 End Point Corporation, http://www.endpoint.com/ + +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. -Original author: Ethan Rowe (ethan@endpoint.com) End Point Corporation +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. -This module has tests. It also probably has bugs. It is, after all, software. +You should have received a copy of the GNU General Public License +along with this program. If not, see: http://www.gnu.org/licenses/ =cut lib/Camp/Config.pm @@ -69,6 +69,18 @@ our $VERSION = '3.00'; vcs_type ); + +=head1 NAME + +Camp::Master - library routines for management of camps + +=head1 VERSION + +3.00 + +=cut + + my ( @base_edits, @edits, @@ -382,8 +394,6 @@ choice and the default simple happens automatically. Here's an example of a file: -=over - # The /var/www/html docroot will be symlinked to $camp/htdocs by default, # but the user is given the choice to override with a copy. --- @@ -413,8 +423,6 @@ Here's an example of a file: =back -=back - =cut sub process_copy_paths { @@ -2834,4 +2842,29 @@ If you want to make use of SVK with the camp system, please look at the configur with specific attention paid to I<repo_mirror> and I<repo_svk_path>; these dictate how the SVK repositories are created and managed over time. +=head1 BUGS AND LIMITATIONS + +This module has tests. It also probably has bugs. It is, after all, software. + +=head1 AUTHOR + +Ethan Rowe E<lt>ethan@endpoint.comE<gt> and other contributors + +=head1 LICENSE AND COPYRIGHT + +Copyright (C) 2006-2009 End Point Corporation, http://www.endpoint.com/ + +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: http://www.gnu.org/licenses/ + =cut lib/Camp/Master.pm 814e6d61a14b8d1ae07cfeda1e4cc2049c66f19e Jon Jensen jon@endpoint.com http://github.com/devcamps/camps/commit/03a1478bcd141cddd3565ccca0eda52a299e6d01 03a1478bcd141cddd3565ccca0eda52a299e6d01 2009-04-06T10:13:47-07:00 2009-04-06T10:13:01-07:00 Add formal copyright and license information, and POD for all commands. 1708a4a5bfa4f652a6116d6b218e8f25e46fb50d Jon Jensen jon@endpoint.com