From fc03d737fe6632cc05a38041ccde3851c4ad79cd Mon Sep 17 00:00:00 2001 From: Marc Espie Date: Tue, 10 Jul 2018 09:05:48 +0000 Subject: rename some pkg checking tools --- share/man/man1/Makefile | 8 +- share/man/man1/check-manpages.1 | 60 ----------- share/man/man1/check-problems.1 | 191 ------------------------------------ share/man/man1/pkg_check-manpages.1 | 60 +++++++++++ share/man/man1/pkg_check-problems.1 | 191 ++++++++++++++++++++++++++++++++++++ 5 files changed, 255 insertions(+), 255 deletions(-) delete mode 100644 share/man/man1/check-manpages.1 delete mode 100644 share/man/man1/check-problems.1 create mode 100644 share/man/man1/pkg_check-manpages.1 create mode 100644 share/man/man1/pkg_check-problems.1 (limited to 'share/man') diff --git a/share/man/man1/Makefile b/share/man/man1/Makefile index 8eaaf55fdec..f738f287a48 100644 --- a/share/man/man1/Makefile +++ b/share/man/man1/Makefile @@ -1,13 +1,13 @@ -# $OpenBSD: Makefile,v 1.13 2018/07/09 17:18:56 espie Exp $ +# $OpenBSD: Makefile,v 1.14 2018/07/10 09:05:47 espie Exp $ # $NetBSD: Makefile,v 1.4 1994/12/22 10:48:04 cgd Exp $ MAN= clang-local.1 help.1 intro.1 gcc-local.1 # ports tools doc -MAN+= check-lib-depends.1 check-manpages.1 check-problems.1 \ - clean-old-distfiles.1 dpb-replay.1 dpb.1 \ +MAN+= check-lib-depends.1 clean-old-distfiles.1 dpb-replay.1 dpb.1 \ outdated-perl-ports.1 \ - pkg_outdated.1 pkg_subst.1 \ + pkg_check-problems.1 pkg_check-manpages.1 pkg_outdated.1 \ + pkg_subst.1 \ port-getpkgpath-helper.1 port-resolve-lib-helper.1 \ port-search-helper.1 \ portbump.1 portcheck.1 portgen.1 \ diff --git a/share/man/man1/check-manpages.1 b/share/man/man1/check-manpages.1 deleted file mode 100644 index f31d545c4ef..00000000000 --- a/share/man/man1/check-manpages.1 +++ /dev/null @@ -1,60 +0,0 @@ -.\" $OpenBSD: check-manpages.1,v 1.1 2018/06/26 05:38:49 espie Exp $ -.\" -.\" Copyright (c) 2010 Marc Espie -.\" -.\" Permission to use, copy, modify, and distribute this software for any -.\" purpose with or without fee is hereby granted, provided that the above -.\" copyright notice and this permission notice appear in all copies. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -.\" -.Dd $Mdocdate: June 26 2018 $ -.Dt CHECK-MANPAGES 1 -.Os -.Sh NAME -.Nm check-manpages -.Nd verify manpage subjects in packages -.Sh SYNOPSIS -.Nm check-manpages -.Op Fl p -.Op Ar pkgname ... -.Sh DESCRIPTION -.Nm -is used to check manpages in a collection of packages. -It will extract all manpages from the -.Ar pkgname -arguments into a directory named -.Pa manpages.XXXXXXXXXXXX -.Po -see -.Xr mktemp 1 -.Pc -and run them through -.Xr makewhatis 8 . -.Pp -Note that this directory is not cleared on exit, so that the problematic -manpages can be examined more precisely. -.Pp -If no -.Ar pkgname -argument is passed, it will process all -.Pa *.tgz -files in the current directory. -.Pp -Options are as follows: -.Bl -tag -width packing-list -.It Fl p -Run -.Xr makewhatis 8 -in picky mode. -.El -.Pp -Errors reported in picky mode should usually be fixed, as it means the -subject line stored in the whatis database will be useless to find out -the corresponding manpage. diff --git a/share/man/man1/check-problems.1 b/share/man/man1/check-problems.1 deleted file mode 100644 index d9d8bfae6f5..00000000000 --- a/share/man/man1/check-problems.1 +++ /dev/null @@ -1,191 +0,0 @@ -.\" $OpenBSD: check-problems.1,v 1.1 2018/06/26 05:38:49 espie Exp $ -.\" -.\" Copyright (c) 2010-2015 Marc Espie -.\" -.\" Permission to use, copy, modify, and distribute this software for any -.\" purpose with or without fee is hereby granted, provided that the above -.\" copyright notice and this permission notice appear in all copies. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -.\" -.Dd $Mdocdate: June 26 2018 $ -.Dt CHECK-PROBLEMS 1 -.Os -.Sh NAME -.Nm check-problems -.Nd verify problems in package collections -.Sh SYNOPSIS -.Nm check-problems -.Op Fl CDesv -.Op Fl d Ar plist_dir -.Op Fl o Ar output -.Op Fl p Ar ports_dir -.Op Ar pkgname ... -.Sh DESCRIPTION -.Nm -is used to check a collection of packages for problems that cannot be -noticed in individual packages, such as conflict and directory registration -issues. -.Pp -A conflict is a file that belongs to two distinct packages. -.Pp -By default, packages with the same stem -.Po -see -.Xr packages-specs 7 -.Pc -are registered to conflict. -This can be changed to add or remove extra conflict registration with -.Cm @option no-default-conflict -or -.Cm @conflict -.Po -see -.Xr pkg_create 1 -.Pc . -.Pp -Conflicts between packages mean that a user can't have both packages installed -at the same time. -In some cases (same software, different version), this is expected, but -the packages should be marked as conflicting, so that -.Xr pkg_add 1 -knows how to deal with it. -In other cases, this is an oversight from the ports maintainer, and action -should be taken to make sure both packages can be installed simultaneously. -Conflicts also interact with dependencies, and sometimes a missing dependency -will show up as an unregistered conflict. -.Pp -Directories can belong to distinct packages, as long as they are registered -somewhere. -Every directory that is not part of the standard -.Xr mtree 8 -set should appear in a packing-list somewhere. -.Pp -Contrary to files, directories can be shared between several packages. -.Pp -.Nm -knows enough about packages to trace directories back to a common dependency, -or to not flag two packages as conflicting when they depend on already -conflicting packages. -.Pp -.Nm -requires a set of packing-lists to operate, which it can obtain from -several sources. -The preferred source is the packing-list databases -.Po -see -.Ar PACKAGE_REPOSITORY -in -.Xr bsd.port.mk 5 -and -.Xr register-plist 1 -.Pc , -as it persists over time and can be used to fix update information as well -as current version information. -.Pp -It should be supplemented with the ports tree itself in order to figure -out current versions. -.Pp -Options are as follows: -.Bl -tag -width packing-list -.It Fl C -Do not compute conflict information. -.It Fl D -Do not compute common dir information. -.It Fl e -Check for extra logical conflicts, by adding supplementary -formatted/unformatted manpages, as same name manpages under the -same base directory will shadow one another. -.It Fl o Ar output -Save results to output file as well as writing it on the screen. -.It Fl s -Be silent. -.It Fl v -Be verbose. -.It Fl d Ar plist-dir -Scan directory -.Ar plist-dir -for packing-lists. -.It Fl p Ar portsdir -Traverse the ports directory for packing-lists, using -.Ar print-plist-all . -More than one directory could be specified by delimiting them by colon, -e.g.: -.Pa /usr/ports/x11/kde:/usr/ports/x11/kde4 . -.Pp -If -.Fl d Ar plist-dir -is also used, traverse only the directories corresponding to the packages -under -.Ar plist-dir -to figure out current pkgnames, and annotate those with a -.Sq \&! -in the report. -.El -.Sh SAMPLE OUTPUT -.Bd -literal -Dependency not found zarafa-webaccess-7.1.11p2 -Dependency not found kwebkitpart-1.2p3 -[...] -Common dirs: -!claws-mail-gdata-3.11.1p1-ldap(mail/claws-mail,-gdata,ldap): /usr/local/lib/claws-mail -!claws-mail-pdfviewer-3.11.1p1-ldap(mail/claws-mail,-pdfviewer,ldap): /usr/local/lib/claws-mail -[...] -Conflicts: -!arm-none-eabi-gdb-7.9.1(devel/arm-none-eabi/gdb),!gdb-7.9.1(devel/gdb) - /usr/local/include/gdb/jit-reader.h - /usr/local/share/gdb/system-gdbinit/elinos.py - /usr/local/share/gdb/system-gdbinit/wrs-linux.py -!libnet-1.0.2ap0v0(net/libnet/1.0),libnet-1.0.2ap2(net/libnet/1.0),libnet-1.0.2av0(net/libnet/1.0) - /usr/local/bin/libnet-config-1.0 - /usr/local/include/libnet-1.0/libnet.h - /usr/local/include/libnet-1.0/libnet/libnet-asn1.h - /usr/local/include/libnet-1.0/libnet/libnet-functions.h - /usr/local/include/libnet-1.0/libnet/libnet-headers.h - /usr/local/include/libnet-1.0/libnet/libnet-macros.h - /usr/local/include/libnet-1.0/libnet/libnet-ospf.h - /usr/local/include/libnet-1.0/libnet/libnet-structures.h - /usr/local/lib/libnet-1.0/libnet.a - /usr/local/lib/libnet-1.0/libnet.so.0.0 - /usr/local/lib/libnet-1.0/libpwrite.a - /usr/local/lib/libnet.so.0.0 - /usr/local/man/cat3/libnet.0 -[...] -zathura-pdf-mupdf-0.2.7(textproc/zathura/plugins/mupdf),zathura-pdf-poppler-0.2.5(textproc/zathura/plugins/poppler) - /usr/local/lib/zathura/pdf.so -.Ed -.Bl -bullet -.It -Dependency not found: means some package names could not be found. -Most often happens because of panic issues, and fsck not recovering some -dependency files. -.It -claws-mail directory: missing directory registration. -.Nm -could not find a common ancestor to claws-mail-gdata and claws-mail-pdfviewer, -so it should be added to both. -.It -Conflict between arm-non-eabi-gdb and gdb: -note that both packages are current. -Two choices: either remove the offending files from one package (might break -the other), or mark an explicit conflict between the packages (will prevent -people from installing both at the same time). -.It -Conflict between libnet-...v0 and libnet: -Note that only the v0 version is current. -People forgot to augment the -.Cm @option no-default-conflict -with conflicts against the old version when bumping the -.Ar EPOCH . -.El -.Sh SEE ALSO -.Xr pkg_add 1 , -.Xr pkg_create 1 , -.Xr bsd.port.mk 5 , -.Xr packages-specs 7 diff --git a/share/man/man1/pkg_check-manpages.1 b/share/man/man1/pkg_check-manpages.1 new file mode 100644 index 00000000000..b5c05c7cc3a --- /dev/null +++ b/share/man/man1/pkg_check-manpages.1 @@ -0,0 +1,60 @@ +.\" $OpenBSD: pkg_check-manpages.1,v 1.1 2018/07/10 09:05:47 espie Exp $ +.\" +.\" Copyright (c) 2010 Marc Espie +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: July 10 2018 $ +.Dt PKG_CHECK-MANPAGES 1 +.Os +.Sh NAME +.Nm pkg_check-manpages +.Nd verify manpage subjects in packages +.Sh SYNOPSIS +.Nm +.Op Fl p +.Op Ar pkgname ... +.Sh DESCRIPTION +.Nm +is used to check manpages in a collection of packages. +It will extract all manpages from the +.Ar pkgname +arguments into a directory named +.Pa manpages.XXXXXXXXXXXX +.Po +see +.Xr mktemp 1 +.Pc +and run them through +.Xr makewhatis 8 . +.Pp +Note that this directory is not cleared on exit, so that the problematic +manpages can be examined more precisely. +.Pp +If no +.Ar pkgname +argument is passed, it will process all +.Pa *.tgz +files in the current directory. +.Pp +Options are as follows: +.Bl -tag -width packing-list +.It Fl p +Run +.Xr makewhatis 8 +in picky mode. +.El +.Pp +Errors reported in picky mode should usually be fixed, as it means the +subject line stored in the whatis database will be useless to find out +the corresponding manpage. diff --git a/share/man/man1/pkg_check-problems.1 b/share/man/man1/pkg_check-problems.1 new file mode 100644 index 00000000000..3f891c9c0e6 --- /dev/null +++ b/share/man/man1/pkg_check-problems.1 @@ -0,0 +1,191 @@ +.\" $OpenBSD: pkg_check-problems.1,v 1.1 2018/07/10 09:05:47 espie Exp $ +.\" +.\" Copyright (c) 2010-2015 Marc Espie +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: July 10 2018 $ +.Dt PKG_CHECK-PROBLEMS 1 +.Os +.Sh NAME +.Nm pkg_check-problems +.Nd verify problems in package collections +.Sh SYNOPSIS +.Nm +.Op Fl CDesv +.Op Fl d Ar plist_dir +.Op Fl o Ar output +.Op Fl p Ar ports_dir +.Op Ar pkgname ... +.Sh DESCRIPTION +.Nm +is used to check a collection of packages for problems that cannot be +noticed in individual packages, such as conflict and directory registration +issues. +.Pp +A conflict is a file that belongs to two distinct packages. +.Pp +By default, packages with the same stem +.Po +see +.Xr packages-specs 7 +.Pc +are registered to conflict. +This can be changed to add or remove extra conflict registration with +.Cm @option no-default-conflict +or +.Cm @conflict +.Po +see +.Xr pkg_create 1 +.Pc . +.Pp +Conflicts between packages mean that a user can't have both packages installed +at the same time. +In some cases (same software, different version), this is expected, but +the packages should be marked as conflicting, so that +.Xr pkg_add 1 +knows how to deal with it. +In other cases, this is an oversight from the ports maintainer, and action +should be taken to make sure both packages can be installed simultaneously. +Conflicts also interact with dependencies, and sometimes a missing dependency +will show up as an unregistered conflict. +.Pp +Directories can belong to distinct packages, as long as they are registered +somewhere. +Every directory that is not part of the standard +.Xr mtree 8 +set should appear in a packing-list somewhere. +.Pp +Contrary to files, directories can be shared between several packages. +.Pp +.Nm +knows enough about packages to trace directories back to a common dependency, +or to not flag two packages as conflicting when they depend on already +conflicting packages. +.Pp +.Nm +requires a set of packing-lists to operate, which it can obtain from +several sources. +The preferred source is the packing-list databases +.Po +see +.Ar PACKAGE_REPOSITORY +in +.Xr bsd.port.mk 5 +and +.Xr register-plist 1 +.Pc , +as it persists over time and can be used to fix update information as well +as current version information. +.Pp +It should be supplemented with the ports tree itself in order to figure +out current versions. +.Pp +Options are as follows: +.Bl -tag -width packing-list +.It Fl C +Do not compute conflict information. +.It Fl D +Do not compute common dir information. +.It Fl e +Check for extra logical conflicts, by adding supplementary +formatted/unformatted manpages, as same name manpages under the +same base directory will shadow one another. +.It Fl o Ar output +Save results to output file as well as writing it on the screen. +.It Fl s +Be silent. +.It Fl v +Be verbose. +.It Fl d Ar plist-dir +Scan directory +.Ar plist-dir +for packing-lists. +.It Fl p Ar portsdir +Traverse the ports directory for packing-lists, using +.Ar print-plist-all . +More than one directory could be specified by delimiting them by colon, +e.g.: +.Pa /usr/ports/x11/kde:/usr/ports/x11/kde4 . +.Pp +If +.Fl d Ar plist-dir +is also used, traverse only the directories corresponding to the packages +under +.Ar plist-dir +to figure out current pkgnames, and annotate those with a +.Sq \&! +in the report. +.El +.Sh SAMPLE OUTPUT +.Bd -literal +Dependency not found zarafa-webaccess-7.1.11p2 +Dependency not found kwebkitpart-1.2p3 +[...] +Common dirs: +!claws-mail-gdata-3.11.1p1-ldap(mail/claws-mail,-gdata,ldap): /usr/local/lib/claws-mail +!claws-mail-pdfviewer-3.11.1p1-ldap(mail/claws-mail,-pdfviewer,ldap): /usr/local/lib/claws-mail +[...] +Conflicts: +!arm-none-eabi-gdb-7.9.1(devel/arm-none-eabi/gdb),!gdb-7.9.1(devel/gdb) + /usr/local/include/gdb/jit-reader.h + /usr/local/share/gdb/system-gdbinit/elinos.py + /usr/local/share/gdb/system-gdbinit/wrs-linux.py +!libnet-1.0.2ap0v0(net/libnet/1.0),libnet-1.0.2ap2(net/libnet/1.0),libnet-1.0.2av0(net/libnet/1.0) + /usr/local/bin/libnet-config-1.0 + /usr/local/include/libnet-1.0/libnet.h + /usr/local/include/libnet-1.0/libnet/libnet-asn1.h + /usr/local/include/libnet-1.0/libnet/libnet-functions.h + /usr/local/include/libnet-1.0/libnet/libnet-headers.h + /usr/local/include/libnet-1.0/libnet/libnet-macros.h + /usr/local/include/libnet-1.0/libnet/libnet-ospf.h + /usr/local/include/libnet-1.0/libnet/libnet-structures.h + /usr/local/lib/libnet-1.0/libnet.a + /usr/local/lib/libnet-1.0/libnet.so.0.0 + /usr/local/lib/libnet-1.0/libpwrite.a + /usr/local/lib/libnet.so.0.0 + /usr/local/man/cat3/libnet.0 +[...] +zathura-pdf-mupdf-0.2.7(textproc/zathura/plugins/mupdf),zathura-pdf-poppler-0.2.5(textproc/zathura/plugins/poppler) + /usr/local/lib/zathura/pdf.so +.Ed +.Bl -bullet +.It +Dependency not found: means some package names could not be found. +Most often happens because of panic issues, and fsck not recovering some +dependency files. +.It +claws-mail directory: missing directory registration. +.Nm +could not find a common ancestor to claws-mail-gdata and claws-mail-pdfviewer, +so it should be added to both. +.It +Conflict between arm-non-eabi-gdb and gdb: +note that both packages are current. +Two choices: either remove the offending files from one package (might break +the other), or mark an explicit conflict between the packages (will prevent +people from installing both at the same time). +.It +Conflict between libnet-...v0 and libnet: +Note that only the v0 version is current. +People forgot to augment the +.Cm @option no-default-conflict +with conflicts against the old version when bumping the +.Ar EPOCH . +.El +.Sh SEE ALSO +.Xr pkg_add 1 , +.Xr pkg_create 1 , +.Xr bsd.port.mk 5 , +.Xr packages-specs 7 -- cgit v1.2.3