FreeBSD::Src - A object oriented interface to building FreeBSD from source.

FreeBSD-Src documentation Contained in the FreeBSD-Src distribution.

Index

Code Index:

NAME

Top

FreeBSD::Src - A object oriented interface to building FreeBSD from source.

VERSION

Top

Version 2.0.0

SYNOPSIS

Top

    use FreeBSD::Src;

	#creates a new FreeBSD::Src object and build stuff in /tm[/obj and a kernel config
	#named whatever.
    my $src=FreeBSD::Src->new({obj=>"/tmp/obj", kernel=>"whatever"});
    if($src->error){
        warn('Error: '.$src->error);
    }

    #builds and installs the kernel and world
    $src->makeBuildKernel;
    if($src->error){
        warn('Error: '.$src->error);
    }
    $src->makeInstallKernel;
    if($src->error){
        warn('Error: '.$src->error);
    }
    $src->makeBuildWorld;
    if($src->error){
        warn('Error: '.$src->error);
    }
    $src->makeInstallWorld;
    if($src->error){
        warn('Error: '.$src->error);
    }

METHODS

Top

new

This creates the object that will be used. It takes arguement, which is a hash that contains various options that will be used.

src

This key contains the path to which contains the FreeBSD source. This this does not exist, it results in a permanent error.

The default is '/usr/src' if it is not defined.

obj

This contains the path to the directory that will contain objects created by the compilation.

If not defined, the enviromental variable "MAKEOBJDIR" will be left as it is.

kernel

This is the kernel config that will be build.

If this is defined, it is left up to make to figure out which should be used. For more information, please see the man page make.conf(5).

makeconf

This is the make.conf file to use for the build.

    my $src=FreeBSD::Src->new({obj=>"/tmp/obj", kernel=>"whatever"});
    if($src->error){
        warn('Error: '.$src->error);
    }

makeBuildWorld

Builds the world.

The return is a perl boolean value.

The returned integer from make can be found using the exitint method.

    $src->makeBuildWorld;
    if($src->error){
        warn('Error: '.$src->error);
    }

makeInstallWorld

Installs the world.

The return is a perl boolean value.

The returned integer from make can be found using the exitint method.

    $src->makeInstallWorld;
    if($src->error){
        warn('Error: '.$src->error);
    }

makeBuildKernel

Builds the kernel

The return is a perl boolean value.

The returned integer from make can be found using the exitinit method.

    $src->makeBuildKernel;
    if($src->error){
        warn('Error: '.$src->error);
    }

makeInstallKernel

Install the kernel.

The return is a perl boolean value.

The returned integer from make can be reached in exitint method.

    $src->makeInstallKernel;
    if($src->error){
        warn('Error: '.$src->error);
    }

makeClean

This cleans the build enviroment.

The return is a perl boolean value.

The returned integer from make can be found using the exitinit method.

    $src->makeClean;
    if($src->error){
        warn('Error: '.$src->error);
    }

output

This gets the stdout from make from the previously called method.

    my $output=$src->output;

ERROR RELATED METHODS

Top

error

This returns the current error code, if any.

    my $error=$src->error;
    if($error){
        warn('Error Code: '.$error);
    }

exitint

This is exit int from the make of the last called method.

errorBlank

This is a internal function and should not be called.

ERROR CODES

Top

0

The source directory does not exist.

1

'make buildworld' failed.

2

'make installdworld' failed.

3

'make buildkernel KERNCONF=<kernel>' failed.

4

'make installkernel KERNCONF=<kernel>' failed.

5

The source directory does not exist.

AUTHOR

Top

Zane C. Bowers-Hadley, <vvelox at vvelox.net>

BUGS

Top

Please report any bugs or feature requests to bug-freebsd-src at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=FreeBSD-Src. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

Top

You can find documentation for this module with the perldoc command.

    perldoc FreeBSD::Src

You can also look for information at:

* RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=FreeBSD-Src

* AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/FreeBSD-Src

* CPAN Ratings

http://cpanratings.perl.org/d/FreeBSD-Src

* Search CPAN

http://search.cpan.org/dist/FreeBSD-Src

ACKNOWLEDGEMENTS

Top

COPYRIGHT & LICENSE

Top

Copyright 2011 Zane C. Bowers, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

FreeBSD-Src documentation Contained in the FreeBSD-Src distribution. 
package FreeBSD::Src;

use warnings;
use strict;


our $VERSION = '2.0.0';



sub new{
	my %args;
	if (defined( $_[1] )){
		%args=%{$_[1]};
	}

	#create the object that will be passed around
	my $self = {conf=>{}, error=>undef, returnedInt=>undef,
				returned=>undef, permanentError=>undef};
	bless $self;

	#this will be appended to the end of make
	$self->{conf}{makeappend}="";

	#gets what to use as the src directory
	if(!defined($args{src})){
		$self->{conf}{src}="/usr/src";
	}else{
		$self->{conf}{src}=$args{src};
	}

	#gets what to use for the destination directory
	if (defined($args{destdir})){
		$self->{conf}{destdir}=$args{destdir};
		$self->{conf}{makeappend}=$self->{conf}{makeappend}.
		" DESTDIR='".$self->{conf}{destdir}."'";
	}

	#figures out what to use for obj dir
	if(!defined($args{obj})){
		$self->{conf}{obj}=undef;
	}else{
		$self->{conf}{obj}=$args{obj};
	}
	#sets the obj dir
	if (defined($self->{conf}{obj})) {
		$ENV{MAKEOBJDIR}=$self->{conf}{obj};
	}

	if(!defined($args{kernel})){
		$self->{conf}{kernel}=undef;
	}else{
		$self->{conf}{kernel}=$args{kernel};
	}

	#sets the make.conf
	if(!defined($args{makeconf})){
		$self->{conf}{makeconf}="/etc/make.conf";
	}else{
		$self->{conf}{makeconf}=$args{makeconf};
	}

	if(!-e $self->{conf}{src}){
		warn('FreeBSD::Src error:0: The directory source directory, '.$self->{conf}{src}.', does not exist.');
		$self->{permanentError}="5";
		$self->{error}="5";
	}

	return $self;
}


sub makeBuildWorld{
	my ($self)= @_;

	if(defined($self->{permanentError})){
		$self->{error}=$self->{permanentError};
		return undef;
	}

	$self->errorBlank();

	chdir($self->{conf}{src});

	$self->{returned}=`make buildworld __MAKE_CONF=$self->{conf}{makeconf} $self->{conf}{makeappend}`;
	$self->{returnedInt}=$?;
	if (!$self->{returnedInt} == 0){
		$self->{error}=1;
		return undef;
	}
	return 1;
}


sub makeInstallWorld{
	my ($self)= @_;

	if(defined($self->{permanentError})){
		$self->{error}=$self->{permanentError};
		return undef;
	}

	$self->errorBlank();

	chdir($self->{conf}{src});

	$self->{returned}=`make installworld __MAKE_CONF=$self->{conf}{makeconf}  $self->{conf}{makeappend}`;
	$self->{returnedInt}=$?;
	if (!$self->{returnedInt} == 0){
		$self->{error}=2;
		return undef;
	}
	return 1;
}


sub makeBuildKernel{
	my ($self)= @_;

	if(defined($self->{permanentError})){
		$self->{error}=$self->{permanentError};
		return undef;
	}

	$self->errorBlank();

	chdir($self->{conf}{src});

	my $makecommand='make buildkernel __MAKE_CONF='.$self->{conf}{makeconf};
	if (defined($self->{conf}{kernel})) {
		$makecommand=$makecommand.' KERNCONF='.$self->{conf}{kernel};
	}
	$makecommand=$makecommand.' '.$self->{conf}{makeappend};

	$self->{returned}=`$makecommand`;
	$self->{returnedInt}=$?;
	if (!$self->{returnedInt} == 0){
		$self->{error}=3;
		return undef;
	}
	return 1;
}


sub makeInstallKernel{
	my ($self)= @_;

	if(defined($self->{permanentError})){
		$self->{error}=$self->{permanentError};
		return undef;
	}

	$self->errorBlank();

	chdir($self->{conf}{src});

	$self->{returned}=`make installkernel`;
	$self->{returnedInt}=$?;
	if (!$self->{returnedInt} == 0){
		$self->{error}=4;
		return undef;
	}
	return 1;
}


sub makeClean{
	my ($self)= @_;

	if(defined($self->{permanentError})){
		$self->{error}=$self->{permanentError};
		return undef;
	}

	$self->errorBlank();

	chdir($self->{conf}{src});

	$self->{returned}=`make clean`;
	$self->{returnedInt}=$?;
	if (!$self->{returnedInt} == 0){
		$self->{error}=3;
		return undef;
	}
	return 1;
}



sub output{
	my $self=$_[0];

	return $self->{returned};
}


sub error{
	return $_[0]->{error};
}


sub exitint{
	return $_[0]->{returnedInt};
}


#blanks the error flags
sub errorBlank{
        my $self=$_[0];

        $self->{error}=undef;

        return 1;
}


1; # End of FreeBSD::Src