document new ${DISTDIR}/history semantics

1 files changed, 27 insertions, 4 deletions

diff --git a/share/man/man7/mirroring-ports.7 b/share/man/man7/mirroring-ports.7
index 4ee2879403d..08b890cb546 100644
--- a/share/man/man7/mirroring-ports.7
+++ b/share/man/man7/mirroring-ports.7
@@ -1,4 +1,4 @@
-.\" $OpenBSD: mirroring-ports.7,v 1.20 2012/01/06 16:50:58 espie Exp $
+.\" $OpenBSD: mirroring-ports.7,v 1.21 2012/01/08 20:29:04 espie Exp $
 .\"
 .\" Copyright (c) 2000,2012 Marc Espie
 .\"
@@ -24,7 +24,7 @@
 .\" (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 $Mdocdate: January 6 2012 $
+.Dd $Mdocdate: January 8 2012 $
 .Dt MIRRORING-PORTS 7
 .Os
 .Sh NAME
@@ -51,7 +51,7 @@ Limit itself to fetching distfiles, and not build any packages.
 Disregard any architecture or broken annotation, and try to fetch every
 distfile.
 .It
-fetch files to a temporary copy named
+Fetch files to a temporary copy named
 .Ic some_file.part
 using
 .Sq ftp -C
@@ -61,12 +61,35 @@ Keep a global list of sha256 checksums as
 .Ic ${DISTDIR}/distinfo ,
 and use that to refetch files when the ports tree records a changing checksum.
 .It
-create sha256 links under
+Produces a log of old distfiles in
+.Ic ${DISTDIR}/history ,
+.It
+Create sha256 links under
 .Ic ${DISTDIR}/by_cipher/sha256
 as per
 .Xr link-checksum 1 Ns 's
 former duties.
 .El
+.Sh FILES
+.Bl -tag -width toto
+.It Pa ${DISTDIR}/distinfo
+a cache of known distfiles with their respective checksums.
+.It Pa ${DISTDIR}/history
+List of files appearing in
+.Pa ${DISTDIR}/distinfo
+that seem to no longer be required by the ports tree.
+.Xr dpb 1
+will append to this file each time it is run on the whole tree
+(option
+.Fl a )
+and only if the ports tree scan finishes without error.
+Each line is of the form
+.Bd -offset indent
+.Li timestamp SHA256(file) = sha
+.Ed
+.Pp
+denoting the first fime a file/sha entry was no longer seen in the ports tree.
+.El
 .Sh SEE ALSO
 .Xr dpb 1 ,
 .Xr ports 7