.\"	$NetBSD: replace-commonbump.1,v 1.3 2015/02/09 00:58:44 snj Exp $
.\"
.\" Copyright (c) 2014 The NetBSD Foundation, Inc.
.\"
.\" This code was originally contributed to the NetBSD Foundation, Inc.
.\" by Makoto Fujiwara <mef@NetBSD.org>.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. 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.
.\" 3. Neither the name of author 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 NETBSD FOUNDATION, INC. 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 FOUNDATION OR CONTRIBUTORS 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.
.\"
.Dd February 9, 2015
.Dt REPLACE-COMMONBUMP 1
.Os
.Sh NAME
.Nm replace-commonbump
.Nd tool to help expanding (replacing) commonbump file to the real list of Makefiles
.Sh SYNOPSIS
.Nm
.Op Fl ah
.Op Fl p Ar pkgsrcdir
.Op Fl T Ar list_file
.Sh DESCRIPTION
.Nm
is a perl script for pkgsrc developers.
It simplifies the process expanding
.Pa commonbump
file into
.Pa commonbump-replace .
The
.Pa commonbump
file is to be created by the first stage of the
.Dv PKGREVISION
bump process as described in
.Xr revbump 1 .
.Pp
.Nm Fl h
displays a short usage.
.Pp
If
.Fl p
is given,
.Ar pkgsrcdir
is used instead of the default
.Pa /usr/pkgsrc .
.Pp
If
.Fl a
is given,
check the whole pkgsrc tree, disregard both the
.Fl T
option and the default
.Pa commonbump
file.
It will check if
.Dq # used by
is included or not, usually in Makefile.common in the package.
.Pp
If
.Fl T
is given,
.Ar list_file
is used instead of the default
.Pa commonbump .
.Pp
.Nm
prints the package name
(in
.Ar category/package
form) on stdout for each package where it failed, but usually none.
.Pp
The internal process is divided into three stages.
.Bl -enum
.It
Read entire pkgsrc tree and check the
.Ar referer -> referenced
relation,
then internally keeps (opposite)
.Ar referenced -> referer
relation table.
.It
Read a file, named
.Pa commonbump
or the argument given with
.Fl T ,
which usually lists
.Pa Makefile.common
or
.Pa *common.mk
files to be expanded.
.It
Expand the filenames listed in
.Pa commonbump
into the list of packagename/Makefile by the
referenced -> referer relation.
.Nm
then outputs to the file
.Pa commonbump.replaced
(currently the name is fixed).
.El
.Sh ENVIRONMENT
.Ev PKGSRCDIR
pkgsrc root directory.
Defaults to
.Pa /usr/pkgsrc .
.Sh SEE ALSO
.Xr blbump 1 ,
.Xr check-cvs-diff 1 ,
.Xr finddepends 1 ,
.Xr revbump 1