Tue Dec 16 11:38:55 2014 UTC ()
Improve documentation.


(wiz)
diff -r1.1 -r1.2 pkgsrc/pkgtools/revbump/files/check-cvs-diff.1
diff -r1.1 -r1.2 pkgsrc/pkgtools/revbump/files/replace-commonbump.1
diff -r1.22 -r1.23 pkgsrc/pkgtools/revbump/files/revbump.1

cvs diff -r1.1 -r1.2 pkgsrc/pkgtools/revbump/files/Attic/check-cvs-diff.1 (expand / switch to unified diff)

--- pkgsrc/pkgtools/revbump/files/Attic/check-cvs-diff.1 2014/12/15 23:25:54 1.1
+++ pkgsrc/pkgtools/revbump/files/Attic/check-cvs-diff.1 2014/12/16 11:38:54 1.2
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1.\" $NetBSD: check-cvs-diff.1,v 1.1 2014/12/15 23:25:54 mef Exp $ 1.\" $NetBSD: check-cvs-diff.1,v 1.2 2014/12/16 11:38:54 wiz Exp $
2.\" 2.\"
3.\" Copyright (c) 2003, 2004, 2005 The NetBSD Foundation, Inc. 3.\" Copyright (c) 2003, 2004, 2005 The NetBSD Foundation, Inc.
4.\" 4.\"
5.\" This code was originally contributed to the NetBSD Foundation, Inc. 5.\" This code was originally contributed to the NetBSD Foundation, Inc.
6.\" by Makoto Fujiwara <mef@NetBSD.org>. 6.\" by Makoto Fujiwara <mef@NetBSD.org>.
7.\" 7.\"
8.\" Redistribution and use in source and binary forms, with or without 8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions 9.\" modification, are permitted provided that the following conditions
10.\" are met: 10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright 11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer. 12.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\" notice, this list of conditions and the following disclaimer in 14.\" notice, this list of conditions and the following disclaimer in
@@ -21,57 +21,59 @@ @@ -21,57 +21,59 @@
21.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND 21.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
22.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, 22.\" CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
23.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 23.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25.\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY 25.\" IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
26.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
28.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 29.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
30.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 30.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
31.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 31.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
32.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33.\" 33.\"
34.Dd December 14, 2014  34.Dd December 14, 2014
35.Dt CHECK-CVS-DIFF 1 35.Dt CHECK-CVS-DIFF 1
36.Os 36.Os
37.Sh NAME 37.Sh NAME
38.Nm check-cvs-diff 38.Nm check-cvs-diff
39.Nd tool to check if revbump process described in revbump(1) results including py27, py34 or ruby200 39.Nd clean up unintended revbump(1) replacements
40in the files. And then replaces the strings by the variable notation. 
41.Sh SYNOPSIS 40.Sh SYNOPSIS
42.Nm 41.Nm
43.Op Fl h 42.Op Fl hv
44.Op Fl p Ar pkgsrcdir 43.Op Fl p Ar pkgsrcdir
45.Op Fl v 44.Ar cvs-diff-u_output-file
46cvs-diff-u_output-file 
47.Sh DESCRIPTION 45.Sh DESCRIPTION
48.Nm 46.Nm
49is a perl script for pkgsrc developers that simplifies checking and replacing fixed 47is a perl script for pkgsrc developers that simplifies checking and replacing fixed
50version number in revbump resultant tree, Makefile and buildlink3.mk files. 48version number in
51It reads `cvs diff -u' output written in named file, and if above mentioned strings found in the diff, replaces it in corresponding file by apropriate variable notation. 49.Xr revbump 1
 50resultant tree, Makefile and buildlink3.mk files.
 51It reads `cvs diff -u' output written in named file, and if above
 52mentioned strings are found in the diff, replaces them in corresponding
 53file by the appropriate variables.
52.Pp 54.Pp
53.Nm Fl h 55.Nm Fl h
54displays a short usage. 56displays a short usage.
55.Pp 57.Pp
56If 58If
57.Fl p 59.Fl p
58is given, 60is given,
59.Ar pkgsrcdir 61.Ar pkgsrcdir
60is used instead of the default 62is used instead of the default
61.Pa /usr/pkgsrc . 63.Pa /usr/pkgsrc .
62.Pp 64.Pp
63If 65If
64.Fl v 66.Fl v
65is given, 67is given,
66it outputs some verbose information. 68.Nm
67 69outputs more verbose information.
 70.Pp
68.Nm 71.Nm
69prints the package name 72prints the package name
70(in 73(in
71.Ar category/package 74.Ar category/package
72form) on stdout for each package where it failed, but usually none. 75form) on stdout for each package where it failed, but usually none.
73 
74.Sh SEE ALSO 76.Sh SEE ALSO
75.Xr revbump 1 , 
76.Xr finddepends 1 , 77.Xr finddepends 1 ,
77.Xr replace-commonbump 1 78.Xr replace-commonbump 1 ,
 79.Xr revbump 1

cvs diff -r1.1 -r1.2 pkgsrc/pkgtools/revbump/files/Attic/replace-commonbump.1 (expand / switch to unified diff)

--- pkgsrc/pkgtools/revbump/files/Attic/replace-commonbump.1 2014/12/15 23:25:54 1.1
+++ pkgsrc/pkgtools/revbump/files/Attic/replace-commonbump.1 2014/12/16 11:38:54 1.2
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1.\" $NetBSD: replace-commonbump.1,v 1.1 2014/12/15 23:25:54 mef Exp $ 1.\" $NetBSD: replace-commonbump.1,v 1.2 2014/12/16 11:38:54 wiz Exp $
2.\" 2.\"
3.\" Copyright (c) 2014 The NetBSD Foundation, Inc. 3.\" Copyright (c) 2014 The NetBSD Foundation, Inc.
4.\" 4.\"
5.\" This code was originally contributed to the NetBSD Foundation, Inc. 5.\" This code was originally contributed to the NetBSD Foundation, Inc.
6.\" by Makoto Fujiwara <mef@NetBSD.org>. 6.\" by Makoto Fujiwara <mef@NetBSD.org>.
7.\" 7.\"
8.\" Redistribution and use in source and binary forms, with or without 8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions 9.\" modification, are permitted provided that the following conditions
10.\" are met: 10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright 11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer. 12.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\" notice, this list of conditions and the following disclaimer in 14.\" notice, this list of conditions and the following disclaimer in
@@ -26,81 +26,102 @@ @@ -26,81 +26,102 @@
26.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
28.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28.\" GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 29.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
30.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 30.\" IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
31.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 31.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
32.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33.\" 33.\"
34.Dd December 14, 2014 34.Dd December 14, 2014
35.Dt REPLACE-COMMONBUMP 1 35.Dt REPLACE-COMMONBUMP 1
36.Os 36.Os
37.Sh NAME 37.Sh NAME
38.Nm replace-commonbump 38.Nm replace-commonbump
39.Nd tool to help expanding (replacing) commonbump file to the real list of Makefile's. 39.Nd tool to help expanding (replacing) commonbump file to the real list of Makefiles
40.Sh SYNOPSIS 40.Sh SYNOPSIS
41.Nm 41.Nm
42.Op Fl a 42.Op Fl ah
43.Op Fl h 
44.Op Fl p Ar pkgsrcdir 43.Op Fl p Ar pkgsrcdir
45.Op Fl T Ar list_file 44.Op Fl T Ar list_file
46.Sh DESCRIPTION 45.Sh DESCRIPTION
47.Nm 46.Nm
48is a perl script for pkgsrc developers. It simplifies the process expanding 47is a perl script for pkgsrc developers.
49`commonbump' file into `commonbump-replace'. Commonbump file is to be created by the first stage of revbump process, as is described in revbump(1). 48It simplifies the process expanding
 49.Pa commonbump
 50file into
 51.Pa commonbump-replace .
 52The
 53.Pa commonbump
 54file is to be created by the first stage of the
 55.Dv PKGREVISION
 56bump process as described in
 57.Xr revbump 1 .
50.Pp 58.Pp
51.Nm Fl h 59.Nm Fl h
52displays a short usage. 60displays a short usage.
53.Pp 61.Pp
54If 62If
55.Fl p 63.Fl p
56is given, 64is given,
57.Ar pkgsrcdir 65.Ar pkgsrcdir
58is used instead of the default 66is used instead of the default
59.Pa /usr/pkgsrc . 67.Pa /usr/pkgsrc .
60.Pp 68.Pp
61If 69If
62.Fl a 70.Fl a
63is given, 71is given,
64check all pkgsrc tree, disregard neither to 72check the whole pkgsrc tree, disregard both the
65.Fl T 73.Fl T
66option nor to the default `commonbump' file. 74option and the default
67It will check if "# used by" is included or not, usually in Makefile.common in the package. 75.Pa commonbump
 76file.
 77It will check if
 78.Dq # used by
 79is included or not, usually in Makefile.common in the package.
68.Pp 80.Pp
69If 81If
70.Fl T 82.Fl T
71is given, 83is given,
72.Ar list_file 84.Ar list_file
73is used instead of the default 85is used instead of the default
74.Pa `commonbump' . 86.Pa commonbump .
75.Pp 87.Pp
76.Nm 88.Nm
77prints the package name 89prints the package name
78(in 90(in
79.Ar category/package 91.Ar category/package
80form) on stdout for each package where it failed, but usually none. 92form) on stdout for each package where it failed, but usually none.
81 93.Pp
82The internal process is divided into three stages. 94The internal process is divided into three stages.
83 95.Bl -enum
84.item 96.It
85(1) 97Read entire pkgsrc tree and check the
86Read entire pkgsrc tree and check a 
87.Ar referer -> referenced 98.Ar referer -> referenced
88relation, 99relation,
89then internally keeps (opposite) 100then internally keeps (opposite)
90.Ar referenced -> referer 101.Ar referenced -> referer
91relation table. 102relation table.
92 103.It
93.item 104Read a file, named
94(2) Read a file, named `commonbump' or the other name given with -T, which 105.Pa commonbump
95usually lists Makefile.common or *common.mk files to be expanded. 106or the argument given with
96 107.Fl T ,
97.item 108which usually lists
98(3) Now expands the filename listed in `commonbump' into the list of packagename/Makefile by 109.Pa Makefile.common
99referenced -> referer relation. It then outputs to the file 110or
100`commonbump.replaced' (currently the name is fixed). 111.Pa *common.mk
101 112files to be expanded.
 113.It
 114Expand the filenames listed in
 115.Pa commonbump
 116into the list of packagename/Makefile by the
 117referenced -> referer relation.
 118.Nm
 119then outputs to the file
 120.Pa commonbump.replaced
 121(currently the name is fixed).
 122.El
102.Sh SEE ALSO 123.Sh SEE ALSO
103.Xr revbump 1 , 
104.Xr blbump 1 , 124.Xr blbump 1 ,
105.Xr check-cvs-diff 1 , 125.Xr check-cvs-diff 1 ,
106.Xr finddepends 1 126.Xr finddepends 1 ,
 127.Xr revbump 1

cvs diff -r1.22 -r1.23 pkgsrc/pkgtools/revbump/files/Attic/revbump.1 (expand / switch to unified diff)

--- pkgsrc/pkgtools/revbump/files/Attic/revbump.1 2014/12/15 23:25:54 1.22
+++ pkgsrc/pkgtools/revbump/files/Attic/revbump.1 2014/12/16 11:38:54 1.23
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1.\" $NetBSD: revbump.1,v 1.22 2014/12/15 23:25:54 mef Exp $ 1.\" $NetBSD: revbump.1,v 1.23 2014/12/16 11:38:54 wiz Exp $
2.\" 2.\"
3.\" Copyright (c) 2003, 2004, 2005, 2006, 2010, 2012, 2013, 2014 The NetBSD Foundation, Inc. 3.\" Copyright (c) 2003, 2004, 2005, 2006, 2010, 2012, 2013, 2014 The NetBSD Foundation, Inc.
4.\" 4.\"
5.\" This code was originally contributed to the NetBSD Foundation, Inc. 5.\" This code was originally contributed to the NetBSD Foundation, Inc.
6.\" by Julio Merino <jmmv@NetBSD.org> and Thomas Klausner <wiz@NetBSD.org>. 6.\" by Julio Merino <jmmv@NetBSD.org> and Thomas Klausner <wiz@NetBSD.org>.
7.\" 7.\"
8.\" Redistribution and use in source and binary forms, with or without 8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions 9.\" modification, are permitted provided that the following conditions
10.\" are met: 10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright 11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer. 12.\" notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\" notice, this list of conditions and the following disclaimer in 14.\" notice, this list of conditions and the following disclaimer in
@@ -86,22 +86,22 @@ would be: @@ -86,22 +86,22 @@ would be:
86.Bd -literal -offset indent 86.Bd -literal -offset indent
87cd /usr/pkgsrc ; 87cd /usr/pkgsrc ;
88finddepends category/package | sort -u \*[Gt] allbump ; 88finddepends category/package | sort -u \*[Gt] allbump ;
89grep buildlink3.mk allbump | sed 's/.buildlink3.mk//' \*[Gt] bl3bump ; 89grep buildlink3.mk allbump | sed 's/.buildlink3.mk//' \*[Gt] bl3bump ;
90grep -e Makefile.common -e mk$ allbump | grep -v -e buildlink3.mk -e options.mk > commonbump ; 90grep -e Makefile.common -e mk$ allbump | grep -v -e buildlink3.mk -e options.mk > commonbump ;
91replace-commonbump ; 91replace-commonbump ;
92cat allbump commonbump.replaced | sed 's,/[^/]*$,,' | sort -u \*[Gt] makebump ; 92cat allbump commonbump.replaced | sed 's,/[^/]*$,,' | sort -u \*[Gt] makebump ;
93revbump \*[Lt] makebump | tee makebump.manual ; 93revbump \*[Lt] makebump | tee makebump.manual ;
94# [if a package is listed in makebump.manual, handle the PKGREVISION bump manually] 94# [if a package is listed in makebump.manual, handle the PKGREVISION bump manually]
95blbump \*[Lt] bl3bump | tee bl3bump.manual ; 95blbump \*[Lt] bl3bump | tee bl3bump.manual ;
96# [handle the *ABI_DEPENDS* bumps in bl3bump.manual manually, usually none] ; 96# [handle the *ABI_DEPENDS* bumps in bl3bump.manual manually, usually none] ;
97cvs diff -u `cat makebump` > cvs-diff ; 97cvs diff -u `cat makebump` > cvs-diff ;
98check-cvs-diff ; 98check-cvs-diff ;
99cvs diff `cat bl3bump makebump` | less  99cvs diff `cat bl3bump makebump` | less
100cvs commit `cat bl3bump makebump` 100cvs commit `cat bl3bump makebump`
101rm allbump bl3bump* makebump* commonbump* cvs-diff 101rm allbump bl3bump* makebump* commonbump* cvs-diff
102.Ed 102.Ed
103.Sh SEE ALSO 103.Sh SEE ALSO
104.Xr blbump 1 , 104.Xr blbump 1 ,
 105.Xr check-cvs-diff 1 ,
105.Xr finddepends 1 , 106.Xr finddepends 1 ,
106.Xr replace-commonbump 1, 107.Xr replace-commonbump 1
107.Xr check-cvs-diff 1