From 88d920d049dcc34c8820eafa71a653a1a788bd92 Mon Sep 17 00:00:00 2001 From: Oliver Gorwits Date: Wed, 2 Jan 2013 20:14:15 +0000 Subject: [PATCH] update packaging files and POD --- Netdisco/LICENCE | 24 ++++++++++++++++++++++++ Netdisco/MANIFEST | 3 +++ Netdisco/META.yml | 5 +++-- Netdisco/lib/App/Netdisco.pm | 7 +++++-- README.txt | 9 ++++++--- 5 files changed, 41 insertions(+), 7 deletions(-) create mode 100644 Netdisco/LICENCE diff --git a/Netdisco/LICENCE b/Netdisco/LICENCE new file mode 100644 index 00000000..acff9c0b --- /dev/null +++ b/Netdisco/LICENCE @@ -0,0 +1,24 @@ +Copyright (c) 2012, The Netdisco Developer Team +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + * Neither the name of the Netdisco Project nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE NETDISCO DEVELOPER TEAM BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/Netdisco/MANIFEST b/Netdisco/MANIFEST index 49b8adee..ef28e048 100644 --- a/Netdisco/MANIFEST +++ b/Netdisco/MANIFEST @@ -1,5 +1,6 @@ bin/nd-dbic-versions bin/netdisco-daemon +bin/netdisco-daemon-fg bin/netdisco-db-deploy bin/netdisco-deploy bin/netdisco-web @@ -17,6 +18,7 @@ inc/Module/Install/WriteAll.pm lib/App/Netdisco.pm lib/App/Netdisco/Daemon/DB.pm lib/App/Netdisco/Daemon/DB/Result/Admin.pm +lib/App/Netdisco/Daemon/Queue.pm lib/App/Netdisco/Daemon/Worker/Interactive.pm lib/App/Netdisco/Daemon/Worker/Interactive/DeviceActions.pm lib/App/Netdisco/Daemon/Worker/Interactive/PortActions.pm @@ -75,6 +77,7 @@ lib/App/Netdisco/Web/Device.pm lib/App/Netdisco/Web/Inventory.pm lib/App/Netdisco/Web/PortControl.pm lib/App/Netdisco/Web/Search.pm +LICENCE Makefile.PL MANIFEST This list of files META.yml diff --git a/Netdisco/META.yml b/Netdisco/META.yml index 1308a0fb..21cc2690 100644 --- a/Netdisco/META.yml +++ b/Netdisco/META.yml @@ -23,7 +23,7 @@ requires: DBD::SQLite: 0 DBIx::Class: 0 DBIx::Class::Helper::Row::SubClass: 0 - Daemon::Generic: 0 + Daemon::Control: 0 Dancer: 0 Dancer::Plugin::DBIC: 0 File::ShareDir: 0 @@ -31,9 +31,9 @@ requires: HTTP::Tiny: 0 JSON: 0 List::MoreUtils: 0 + MCE: 0 Net::MAC: 0 NetAddr::IP: 0 - Parallel::Prefork: 0 Path::Class: 0 Plack: 0 Role::Tiny: 0 @@ -44,6 +44,7 @@ requires: YAML: 0 namespace::clean: 0 perl: 5.10.0 + version: 0 resources: MailingList: https://lists.sourceforge.net/lists/listinfo/netdisco-users bugtracker: http://sourceforge.net/tracker/?group_id=80033&atid=558508 diff --git a/Netdisco/lib/App/Netdisco.pm b/Netdisco/lib/App/Netdisco.pm index ae6c267d..6b6bd6ae 100644 --- a/Netdisco/lib/App/Netdisco.pm +++ b/Netdisco/lib/App/Netdisco.pm @@ -87,9 +87,9 @@ e.g. C<~netdisco/bin>: ln -s ~/perl5/bin/{localenv,netdisco-*} ~/bin/ Test the installation by running the following command, which should only -produce some help text (and throw up no errors): +produce a status message (and throw up no errors): - localenv netdisco-daemon + localenv netdisco-daemon status =head1 Configuration @@ -144,6 +144,9 @@ For SQL debugging try the following command: DBIC_TRACE_PROFILE=console DBIC_TRACE=1 \ DANCER_ENVDIR=~/environments plackup ~/bin/netdisco-web +To run the job daemon in the foreground, start the C +program instead of C. + =head1 Future Work The intention is to support "plugins" for additonal features, most notably diff --git a/README.txt b/README.txt index 474d3860..36f00adc 100644 --- a/README.txt +++ b/README.txt @@ -49,7 +49,7 @@ Installation --local-lib ~/perl5 \ App::cpanminus \ App::local::lib::helper \ - App::Netdisco + http://cpan.metacpan.org/authors/id/O/OL/OLIVER/App-Netdisco-2.00_012.tar.gz Link some of the newly installed apps into the "netdisco" user's $PATH, e.g. "~netdisco/bin": @@ -57,9 +57,9 @@ Installation ln -s ~/perl5/bin/{localenv,netdisco-*} ~/bin/ Test the installation by running the following command, which should - only produce some help text (and throw up no errors): + only produce a status message (and throw up no errors): - localenv netdisco-daemon + localenv netdisco-daemon status Configuration Make a directory for your local configuration and copy the configuration @@ -110,6 +110,9 @@ Tips and Tricks DBIC_TRACE_PROFILE=console DBIC_TRACE=1 \ DANCER_ENVDIR=~/environments plackup ~/bin/netdisco-web + To run the job daemon in the foreground, start the "netdisco-daemon-fg" + program instead of "netdisco-daemon". + Future Work The intention is to support "plugins" for additonal features, most notably columns in the Device Port listing, but also new menu items and