OSDN Git Service

Edited the man page of portsreinstall-chroot to reflect the new features.
authorMamoru Sakaue / MwGhennndo <glmwghennndo@users.sourceforge.jp>
Wed, 25 Jul 2018 17:45:41 +0000 (01:45 +0800)
committerMamoru Sakaue / MwGhennndo <glmwghennndo@users.sourceforge.jp>
Wed, 25 Jul 2018 17:45:41 +0000 (01:45 +0800)
 Changes to be committed:
modified:   lib/chroot/libfs.sh
modified:   lib/libmain.sh
modified:   man/portsreinstall-chroot.8

lib/chroot/libfs.sh
lib/libmain.sh
man/portsreinstall-chroot.8

index 770f532..5185055 100644 (file)
@@ -97,7 +97,6 @@ fs_build_chroot ()
                echo "$PORTSDIR"
                echo "$PORTSNAP_WORKDIR"
                echo "$PKGNG_PKG_CACHEDIR"
-               echo "$PKGNG_PKG_DBDIR"
        fi | str_regularize_df_path_filter | grep -v '^[[:space:]]*$' | sort -u > ${DBDIR}/shared_dirs.lst
        str_escape_regexp_filter < ${DBDIR}/shared_dirs.lst | sed 's|^|^|;s|$|\/|' > ${TMPDIR}/fs_build_chroot:shared_dirs.regexp
        cp /dev/null "${TMPDIR}/fs_build_chroot:shared_dirs:added"
index 99e737b..04a52c1 100644 (file)
@@ -12,7 +12,7 @@ main_set_version ()
        MYVERSION=4.0.1
        COMPATIBLE_VERSIONS='^(4\.[0]\.[0-1])$'
        # Template for development versions
-       MYVERSION=4.0.0+toward_4.0.1_20180725220511
+       MYVERSION=4.0.0+toward_4.0.1_20180726014524
        COMPATIBLE_VERSIONS='^(4\.[0]\.[0-1]]|4\.[0]\.[0]+(|\+toward_4\.[0]\.[1]+_[0-9]+))$'
 }
 
index 3fb5890..73dd84b 100644 (file)
@@ -216,7 +216,7 @@ Ignore \fBpkgtools.conf\fR(5) even if it exists.
 .PD 0
 .TP
 \fB\-\-share\-port\-pkgs\-dirs\fR
-Share the ports tree (PORTSDIR=/usr/ports by default), portsnap work directory (WORKDIR=/var/db/portsnap in \fBportsnap.conf\fR(5) by default), package cache (PKG_CACHEDIR=/var/cache/pkg in \fBpkg.conf\fR(5) by default)  and package database (PKG_DBDIR=/var/db/pkgs by default) with the host by nullfs.
+Share the ports tree (PORTSDIR=/usr/ports by default), portsnap work directory (WORKDIR=/var/db/portsnap in \fBportsnap.conf\fR(5) by default) and package cache (PKG_CACHEDIR=/var/cache/pkg in \fBpkg.conf\fR(5) by default) with the host by nullfs.
 .PD
 .SH DETAILS
 .SS Overview
@@ -227,14 +227,14 @@ The forked environment is created by \fBnullfs\fR(5) and \fBmount_unionfs\fR(8)
 Fetched/deleted distfiles and created/fetched/deleted packages are synchronized at the host to the forked environment.
 The ports options and other configurations of ports management (\fB/etc/make.conf\fR, \fB/usr/local/etc/portsreinstall.conf\fR, \fB/usr/local/etc/pkgtools.conf\fR, \fB/usr/local/etc/pkg.conf\fR and the temporary database of \fBportsreinstall\fR(8) in usual environments) are also synchronized as well.
 .PP
-The execution of \fBdo\fR command proceeds in the following step:
+The execution of \fBdo\fR command proceeds in the following step (while use of \fBauto\fR command can be more practical):
 .TP
 1.
 This utility will create and mount the \fBchroot\fR(8) builder environment.
 .PD
 .TP
 2.
-This utility will enter the builder environment, and the user will be prompted in a shell to complete the upgrade of pakages by \fBportsreinstall\fR(8).
+This utility will enter the builder environment, and the user will be prompted in a shell to complete the upgrade of packages by \fBportsreinstall\fR(8).
 .PD
 .TP
 3.
@@ -246,7 +246,7 @@ This utility will create packages and an archive of dispatch script for upgrade.
 .PD
 .TP
 5.
-This utility will synchronize the host environment to the builder about distfiles, pakage files, ports options and other configurations of ports management.
+This utility will synchronize the host environment to the builder about distfiles, package files, ports options and other configurations of ports management.
 .PD
 .TP
 6.
@@ -264,39 +264,65 @@ root@[host]#
 root@[host]#
 .B pkg update
 .RE
-2. Launch a "forked" chroot environment by executing this utility.
+2. Execute \fBportsreinstall\fR(8) in a "forked" builder \fBchroot\fR(8) environment by launching from this utility.
+The sample set of options will be one of the convenient choices for building in the \fBchroot\fR(8) environment.
 .RS
 root@[host]#
-.B portsreinstall\-chroot
+.B portsreinstall\-chroot auto -CGqx
 .RE
-3. Then the user will be prompted in the chroot (builder) environment.
+3. After successful build of the temporary database, \fBportsreinstall\fR(8) may show select dialogues for leaf and obsolete ports/packages.
+Note that the choice made here can be changed afterward without any fatal risk as long as the current builder \fBchroot\fR(8) environment is preserved even after the upgrade of the host environment.
+.PP
+4. \fBportsreinstall\fR(8) will continue to build, (re)install and deinstall processes, which take very long and impose a high load.
+You may want to interrupt the execution to cool down or shutdown your machine for your work or travel.
+In this case, press Ctrl+C at any point so that \fBportsreinstall\fR(8) will stop by preserving its progress marker information in the temporary database and this utility will unmount the builder \fBchroot\fR(8) environment.
+Some network troubles in fetching distfiles or packages may be resolved by terminating the process once.
+(Even damages due to critical accidents of kernel panics, overheating and sudden shutdown may be recovered without problem just like this intentional termination.)
 .RS
-root@[chroot]#
+.B Ctrl+C
+.RE
+5. At any convenient time, restart the processes.
+Note that no option should be speified here.
+.RS
+root@[host]#
+.B portsreinstall\-chroot auto
+.RE
+6. The process may stop with some failures which cannot be resolved automatically.
+It may be mismatches of port option configurations of dependencies, unrecognized conflict or essential conflict between needed packages.
+In this case, you will need to enter the builder \fBchroot\fR(8) environment for the manual troubleshooting.
+.RS
+root@[host]#
+.B portsreinstall\-chroot enter
 .RE
-4. In the chroot (builder) environment, upgrade the all pakages completely by \fBportsreinstall\fR (the command line options are just an example; muitiple redoing and reconfiguration of port options and other configuration files of ports management may be required).
-It is highly recommended to put \fB\-x\fR option.
+7. Then the you will be prompted in the builder \fBchroot\fR(8) environment.
 .RS
 root@[chroot]#
-.B portsreinstall -qxC
 .RE
-5. Exit from the chroot (builder) environment.
+8. Troubleshooting may be done by modifying the configuration files or struggling with \fBfreeze\fR/\fBtaboo\fR/\fBescape\fR/\fBok\fR/\fBneed\fR/\fBnoneed\fR/\fBreselect\fR/\fBreconf\fR commands of \fBportsreinstall\fR(8) referring to information obtained by \fBshow\fR command of \fBportsreinstall\fR(8).
+After such possible patchwork, exit from the builder \fBchroot\fR(8) environment.
 .RS
 root@[chroot]#
 .B exit
 .RE
-6. When the exit code is zero and the upgrading of ports is complete, following processes will be carried out automatically. Otherwise, the process will be terminated here.
-.PP
-7. Updated packages and dispatch script set will be created by internally invoking \fBportsreinstall packupgrade create\fR and \fBportsreinstall packupgrade archive\fR commands.
-.PP
-8. Then distfiles, pakage files, ports options and other configurations of ports management will be synchronized from the chroot (builder) environment.
-.PP
-9. Then the ports in the host (target) environment will be updated by internally invoking the dispatched script set.
+9. Retry to continue the processes by executing
+.RS
+root@[host]#
+.B portsreinstall\-chroot auto
+.RE
+or, when the configuration files were modified,
+.RS
+root@[host]#
+.B portsreinstall\-chroot auto -L redo
+.RE
+10. When the all necessary upgrade is completed inside the builder \fBchroot\fR(8) environment, you will be asked whether to reflect the upgrade to the host environment.
+If you select Yes here, package archiving in the builder \fBchroot\fR(8) environment, synchronization of package files, distfiles, port option database and configuration files for \fBportsreinstall\fR(8), and the update of the packages at the host environment will be automatically carried out.
+Here, again, Ctrl+C interruption and unintentional termination will be recovered by simple re-exeution of this utility.
 .SH "ENVIRONMENT VARIABLES"
 .TP
 .B SYSTEMBASE
 (Used only when the target environment is a virtual environment implemented by \fBchroot\fR(8) or \fBjail\fR(8))
 The base directory of the target environment at its grand host environment.
-This variable is referred by portsreinstall\-chroot\-mount, which is to be executed in the grand host environment of the target environment.
+This variable is referred by \fBportsreinstall\-chroot\-mount\fR(8), which is to be executed in the grand host environment of the target environment.
 The default is the two-levels higher directory of PREFIX applied for installation of \fBportsreinstall\fR(8) in the target environment.
 .PP
 See also the corresponding section of \fBportsreinstall\fR(8).