From 4211f5cd098608d612597685f8bfae50d57ec8f3 Mon Sep 17 00:00:00 2001 From: Juan RP Date: Wed, 28 Oct 2015 09:37:09 +0100 Subject: [PATCH] New manual page for xbps-fbulk(1). --- NEWS | 2 + bin/xbps-checkvers/xbps-checkvers.1 | 3 +- bin/xbps-create/xbps-create.1 | 3 +- bin/xbps-dgraph/xbps-dgraph.1 | 3 +- bin/xbps-fbulk/Makefile | 1 - bin/xbps-fbulk/main.c | 7 +- bin/xbps-fbulk/xbps-fbulk.1 | 114 ++++++++++++++++++++++++ bin/xbps-install/xbps-install.1 | 3 +- bin/xbps-pkgdb/xbps-pkgdb.1 | 3 +- bin/xbps-reconfigure/xbps-reconfigure.1 | 3 +- bin/xbps-remove/xbps-remove.1 | 3 +- bin/xbps-rindex/xbps-rindex.1 | 3 +- bin/xbps-uchroot/xbps-uchroot.1 | 3 +- bin/xbps-uunshare/xbps-uunshare.1 | 3 +- 14 files changed, 141 insertions(+), 13 deletions(-) create mode 100644 bin/xbps-fbulk/xbps-fbulk.1 diff --git a/NEWS b/NEWS index e3adb41b..bf6f704a 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,7 @@ xbps-0.48 (???): + * xbps-fbulk(1): now comes with a manual page for the section 1. + * libxbps: implemented reverse conflicts. That means that just a single pkg needs to set conflicts to be effective, rather than all involved pkgs. diff --git a/bin/xbps-checkvers/xbps-checkvers.1 b/bin/xbps-checkvers/xbps-checkvers.1 index 5508a630..48847b62 100644 --- a/bin/xbps-checkvers/xbps-checkvers.1 +++ b/bin/xbps-checkvers/xbps-checkvers.1 @@ -1,4 +1,4 @@ -.Dd May 16, 2015 +.Dd October 28, 2015 .Dt XBPS-CHECKVERS 1 .Sh NAME .Nm xbps-checkvers @@ -51,6 +51,7 @@ Shows the XBPS version. .Sh SEE ALSO .Xr xbps-create 1 , .Xr xbps-dgraph 1 , +.Xr xbps-fbulk 1 , .Xr xbps-install 1 , .Xr xbps-pkgdb 1 , .Xr xbps-query 1 , diff --git a/bin/xbps-create/xbps-create.1 b/bin/xbps-create/xbps-create.1 index 84f3fc75..00d7a3ec 100644 --- a/bin/xbps-create/xbps-create.1 +++ b/bin/xbps-create/xbps-create.1 @@ -1,4 +1,4 @@ -.Dd May 16, 2015 +.Dd October 28, 2015 .Dt XBPS-CREATE 1 .Sh NAME .Nm xbps-create @@ -84,6 +84,7 @@ A list of required shared libraries, separated by whitespaces. Example: .Sh SEE ALSO .Xr xbps-checkvers 1 , .Xr xbps-dgraph 1 , +.Xr xbps-fbulk 1 , .Xr xbps-install 1 , .Xr xbps-pkgdb 1 , .Xr xbps-query 1 , diff --git a/bin/xbps-dgraph/xbps-dgraph.1 b/bin/xbps-dgraph/xbps-dgraph.1 index 0a719135..1e450dea 100644 --- a/bin/xbps-dgraph/xbps-dgraph.1 +++ b/bin/xbps-dgraph/xbps-dgraph.1 @@ -1,4 +1,4 @@ -.Dd May 16, 2015 +.Dd October 28, 2015 .Dt XBPS-DGRAPH 1 .Sh NAME .Nm xbps-dgraph @@ -125,6 +125,7 @@ Default cache directory to store downloaded binary packages. .Xr xbps.d 5 , .Xr xbps-checkvers 1 , .Xr xbps-create 1 , +.Xr xbps-fbulk 1 , .Xr xbps-install 1 , .Xr xbps-pkgdb 1 , .Xr xbps-query 1 , diff --git a/bin/xbps-fbulk/Makefile b/bin/xbps-fbulk/Makefile index 6927840f..68d2e420 100644 --- a/bin/xbps-fbulk/Makefile +++ b/bin/xbps-fbulk/Makefile @@ -2,6 +2,5 @@ TOPDIR = ../.. -include $(TOPDIR)/config.mk BIN = xbps-fbulk -MAN = include $(TOPDIR)/mk/prog.mk diff --git a/bin/xbps-fbulk/main.c b/bin/xbps-fbulk/main.c index 49f3c7c8..c9a58e17 100644 --- a/bin/xbps-fbulk/main.c +++ b/bin/xbps-fbulk/main.c @@ -152,7 +152,7 @@ addItem(const char *pkgn) static void __attribute__((noreturn)) usage(const char *progname) { - fprintf(stderr, "%s [-a targetarch] [-h] [-j parallel] [-l logdir] " + fprintf(stderr, "%s [-a targetarch] [-h] [-j parallel] [-l logdir] [-V]" "/path/to/void-packages [pkg pkgN]\n", progname); exit(EXIT_FAILURE); } @@ -552,7 +552,7 @@ main(int argc, char **argv) { NULL, 0, NULL, 0 } }; - while ((ch = getopt_long(argc, argv, "a:hj:l:v", longopts, NULL)) != -1) { + while ((ch = getopt_long(argc, argv, "a:hj:l:vV", longopts, NULL)) != -1) { switch (ch) { case 'a': TargetArch = optarg; @@ -566,6 +566,9 @@ main(int argc, char **argv) case 'l': LogDir = optarg; break; + case 'V': + printf("%s\n", XBPS_RELVER); + exit(EXIT_SUCCESS); case 'h': default: usage(progname); diff --git a/bin/xbps-fbulk/xbps-fbulk.1 b/bin/xbps-fbulk/xbps-fbulk.1 new file mode 100644 index 00000000..66b5bfee --- /dev/null +++ b/bin/xbps-fbulk/xbps-fbulk.1 @@ -0,0 +1,114 @@ +.Dd October 28, 2015 +.Dt XBPS-FBULK 1 +.Sh NAME +.Nm xbps-fbulk +.Nd XBPS utility to perform a fast bulk build of void-packages +.Sh SYNOPSYS +.Nm xbps-fbulk +.Op OPTIONS +.Ar /path/to/void-packages +.Op pkgN pkgN+1 ... +.Sh DESCRIPTION +The +.Nm +utility iterates all srcpkg directories in the +.Xr void-packages +repository or processes the +.Xr pkgN +arguments, and then runs +.Ar ./xbps-src show-build-deps', +to build a dependency tree on the fly. +.Pp +As the dependency tree is being built, terminal dependencies are built +and packaged on the fly. +.Pp +As these builds complete additional dependencies may be satisfied and be +added to the build order. Ultimately the entire tree is built. +.Pp +Only one attempt is made to build any given package, no matter how many +other packages depend on it. +.Sh OPTIONS +.Bl -tag -width -x +.It Fl a Ar arch +Set a different target architecture, useful for cross compiling. +.It Fl j Ar X +Set number of parallel builds running at the same time. By default set to 1. +.It Fl l Ar logdir +Set the log directory. By default set to `log.`. +.It Fl d, Fl -debug +Enables extra debugging shown to stderr. +.It Fl h, Fl -help +Show the help usage. +.It Fl v, Fl -verbose +Enables verbose messages. +.It Fl V, Fl -version +Shows the XBPS version. +.El +.Sh FILES +.Bl -tag -width logdir/skipped +.It Ar logdir/run +Packages that are being built. +.It Ar logdir/good +Packages that were built successfully. +.It Ar logdir/bad +Packages that failed to build. +.It Ar logdir/skipped +Packages that were not built because they had to be skipped (unsupported architecture, broken or restricted). +.It Ar logdir/deps +Packages that were not built due to missing dependencies. +.El +.Sh NOTES +The +.Ar masterdir +in the +.Ar void-packages +repository must be fully populated for chroot operations, and some options +need to be set in +.Ar etc/conf +to make +.Nm +work correctly: +.Bl -tag -width XBPS_CHROOT_CMD=uchroot +.It Ar XBPS_CHROOT_CMD=uchroot +The +.Xr xbps-uchroot 1 +utility is required because +.Nm +builds packages in temporary masterdirs that are mounted with +.Ar overlayfs . +.El +.Pp +Make sure the user running +.Nm +has rights to execute +.Xr xbps-uchroot 1 +and the kernel supports the overlay filesystem, introduced in 4.0. +.Pp +.Sh SEE ALSO +.Xr xbps-checkvers 1 , +.Xr xbps-create 1 , +.Xr xbps-dgraph 1 , +.Xr xbps-install 1 , +.Xr xbps-pkgdb 1 , +.Xr xbps-query 1 , +.Xr xbps-reconfigure 1 , +.Xr xbps-remove 1 , +.Xr xbps-rindex 1 , +.Xr xbps-uchroot 1 , +.Xr xbps-uunshare 1 , +.Xr xbps.d 5 +.Sh AUTHORS +The +.Nm +utility was originally written by +.An Matthew Dillon +for the +.Ar DragonFlyBSD project. +.Pp +.An Juan Romero Pardines +adapted it for xbps and added some new features. +.Sh BUGS +Probably, but I try to make this not happen. Use it under your own +responsability and enjoy your life. +.Pp +Report bugs in https://github.com/voidlinux/xbps/issues diff --git a/bin/xbps-install/xbps-install.1 b/bin/xbps-install/xbps-install.1 index b3f36bcf..ac0a24a9 100644 --- a/bin/xbps-install/xbps-install.1 +++ b/bin/xbps-install/xbps-install.1 @@ -1,4 +1,4 @@ -.Dd October 20, 2015 +.Dd October 28, 2015 .Dt XBPS-INSTALL 1 .Sh NAME .Nm xbps-install @@ -150,6 +150,7 @@ Default cache directory to store downloaded binary packages. .Xr xbps-checkvers 1 , .Xr xbps-create 1 , .Xr xbps-dgraph 1 , +.Xr xbps-fbulk 1 , .Xr xbps-pkgdb 1 , .Xr xbps-query 1 , .Xr xbps-reconfigure 1 , diff --git a/bin/xbps-pkgdb/xbps-pkgdb.1 b/bin/xbps-pkgdb/xbps-pkgdb.1 index 98682759..3eecd25a 100644 --- a/bin/xbps-pkgdb/xbps-pkgdb.1 +++ b/bin/xbps-pkgdb/xbps-pkgdb.1 @@ -1,4 +1,4 @@ -.Dd May 16, 2015 +.Dd October 28, 2015 .Dt XBPS-PKGDB 1 .Sh NAME .Nm xbps-pkgdb @@ -92,6 +92,7 @@ Default cache directory to store downloaded binary packages. .Xr xbps-checkvers 1 , .Xr xbps-create 1 , .Xr xbps-dgraph 1 , +.Xr xbps-fbulk 1 , .Xr xbps-install 1 , .Xr xbps-query 1 , .Xr xbps-reconfigure 1 , diff --git a/bin/xbps-reconfigure/xbps-reconfigure.1 b/bin/xbps-reconfigure/xbps-reconfigure.1 index 6be45320..0e99925a 100644 --- a/bin/xbps-reconfigure/xbps-reconfigure.1 +++ b/bin/xbps-reconfigure/xbps-reconfigure.1 @@ -1,4 +1,4 @@ -.Dd May 16, 2015 +.Dd October 28, 2015 .Dt XBPS-RECONFIGURE 1 .Sh NAME .Nm xbps-reconfigure @@ -78,6 +78,7 @@ Default cache directory to store downloaded binary packages. .Xr xbps-checkvers 1 , .Xr xbps-create 1 , .Xr xbps-dgraph 1 , +.Xr xbps-fbulk 1 , .Xr xbps-install 1 , .Xr xbps-pkgdb 1 , .Xr xbps-query 1 , diff --git a/bin/xbps-remove/xbps-remove.1 b/bin/xbps-remove/xbps-remove.1 index e2fdb8f8..28d7d7c8 100644 --- a/bin/xbps-remove/xbps-remove.1 +++ b/bin/xbps-remove/xbps-remove.1 @@ -1,4 +1,4 @@ -.Dd October 20, 2015 +.Dd October 28, 2015 .Dt XBPS-REMOVE 1 .Sh NAME .Nm xbps-remove @@ -113,6 +113,7 @@ Default cache directory to store downloaded binary packages. .Xr xbps-checkvers 1 , .Xr xbps-create 1 , .Xr xbps-dgraph 1 , +.Xr xbps-fbulk 1 , .Xr xbps-install 1 , .Xr xbps-pkgdb 1 , .Xr xbps-query 1 , diff --git a/bin/xbps-rindex/xbps-rindex.1 b/bin/xbps-rindex/xbps-rindex.1 index fb582fd5..b884c768 100644 --- a/bin/xbps-rindex/xbps-rindex.1 +++ b/bin/xbps-rindex/xbps-rindex.1 @@ -1,4 +1,4 @@ -.Dd June 4, 2015 +.Dd October 28, 2015 .Dt XBPS-RINDEX 1 .Sh NAME .Nm xbps-rindex @@ -91,6 +91,7 @@ a repository. Otherwise it will ask you to enter the passphrase on the terminal. .Xr xbps-checkvers 1 , .Xr xbps-create 1 , .Xr xbps-dgraph 1 , +.Xr xbps-fbulk 1 , .Xr xbps-install 1 , .Xr xbps-pkgdb 1 , .Xr xbps-query 1 , diff --git a/bin/xbps-uchroot/xbps-uchroot.1 b/bin/xbps-uchroot/xbps-uchroot.1 index a325f531..0f11ef39 100644 --- a/bin/xbps-uchroot/xbps-uchroot.1 +++ b/bin/xbps-uchroot/xbps-uchroot.1 @@ -1,4 +1,4 @@ -.Dd May 16, 2015 +.Dd October 28, 2015 .Dt XBPS-UCHROOT 1 .Sh NAME .Nm xbps-uchroot @@ -75,6 +75,7 @@ other Operating Systems. The following kernel options must be enabled: .Xr xbps-checkvers 1 , .Xr xbps-create 1 , .Xr xbps-dgraph 1 , +.Xr xbps-fbulk 1 , .Xr xbps-install 1 , .Xr xbps-pkgdb 1 , .Xr xbps-query 1 , diff --git a/bin/xbps-uunshare/xbps-uunshare.1 b/bin/xbps-uunshare/xbps-uunshare.1 index 61cb3e39..1a6b6aa6 100644 --- a/bin/xbps-uunshare/xbps-uunshare.1 +++ b/bin/xbps-uunshare/xbps-uunshare.1 @@ -1,4 +1,4 @@ -.Dd May 16, 2015 +.Dd October 28, 2015 .Dt XBPS-UUNSHARE 1 .Sh NAME .Nm xbps-uunshare @@ -54,6 +54,7 @@ other Operating Systems. The following kernel options must be enabled: .Xr xbps-checkvers 1 , .Xr xbps-create 1 , .Xr xbps-dgraph 1 , +.Xr xbps-fbulk 1 , .Xr xbps-install 1 , .Xr xbps-pkgdb 1 , .Xr xbps-query 1 ,