NetBSD Problem Report #54019
From www@NetBSD.org Tue Feb 26 17:30:11 2019
Return-Path: <www@NetBSD.org>
Received: from mail.netbsd.org (mail.netbsd.org [199.233.217.200])
(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
(Client CN "mail.NetBSD.org", Issuer "mail.NetBSD.org CA" (not verified))
by mollari.NetBSD.org (Postfix) with ESMTPS id 4211B7A1E8
for <gnats-bugs@gnats.NetBSD.org>; Tue, 26 Feb 2019 17:30:11 +0000 (UTC)
Message-Id: <20190226173010.719EF7A1ED@mollari.NetBSD.org>
Date: Tue, 26 Feb 2019 17:30:10 +0000 (UTC)
From: jlmuir@imca-cat.org
Reply-To: jlmuir@imca-cat.org
To: gnats-bugs@NetBSD.org
Subject: Guide does not document current directory in FTP server layout appendix
X-Send-Pr-Version: www-1.0
>Number: 54019
>Category: pkg
>Synopsis: Guide does not document current directory in FTP server layout appendix
>Confidential: no
>Severity: non-critical
>Priority: medium
>Responsible: leot
>State: closed
>Class: doc-bug
>Submitter-Id: net
>Arrival-Date: Tue Feb 26 17:35:00 +0000 2019
>Closed-Date: Thu Feb 28 10:58:20 +0000 2019
>Last-Modified: Thu Feb 28 10:58:20 +0000 2019
>Originator: J. Lewis Muir
>Release:
>Organization:
>Environment:
>Description:
At
https://www.netbsd.org/docs/pkgsrc/ftp-layout.html
it does not document the directory named current.
>How-To-Repeat:
>Fix:
It looks like maybe the second paragraph in the "current, stable, pkgsrc-20xxQy" section is documenting what's *in* the directory named current. It could be that prefixing the first sentence of the second paragraph with
In the `current` directory,
would be sufficient. Ideally, though, the first sentence would provide a short description stating what the directory named current is. For example (I'm just guessing):
The `current` directory contains files related to the -current branch of the pkgsrc CVS repository.
>Release-Note:
>Audit-Trail:
From: "J. Lewis Muir" <jlmuir@imca-cat.org>
To: gnats-bugs@NetBSD.org
Cc:
Subject: Re: pkg/54019
Date: Tue, 26 Feb 2019 12:15:06 -0600
Looking at the "current, stable, pkgsrc-20xxQy" section of
https://www.netbsd.org/docs/pkgsrc/ftp-layout.html
more, I'm wondering if I'm misunderstanding the intent of the first
paragraph, and it's actually describing what's in each of the current,
stable, and pkgsrc-20xxQy directories?
If that's the case, then I think this needs to be made more clear. For
example, the first sentence of the second paragraph could be replaced
with
Each of the `current`, `stable`, and `pkgsrc-20xxQy` directories share
the same structure. They each contain a `pkgsrc` directory which
contains a snapshot of their branch of the CVS repository, which is
updated regularly.
But I still think each directory needs a short sentence to say what it
is too. For example:
The `current` directory contains files related to the -current branch
of the CVS repository.
The `stable` directory is a symlink to the latest `pkgsrc-20xxQy`
directory.
The `pkgsrc-20xxQy` directories contain files related to the
-20xxQy branch of the CVS repository. [Then the sentence about the
`pkgsrc-20xxQy.tar.gz` file here.]
Responsible-Changed-From-To: pkg-manager->leot
Responsible-Changed-By: leot@NetBSD.org
Responsible-Changed-When: Thu, 28 Feb 2019 10:24:23 +0000
Responsible-Changed-Why:
Take
From: "Leonardo Taccari" <leot@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc:
Subject: PR/54019 CVS commit: pkgsrc/doc/guide/files
Date: Thu, 28 Feb 2019 10:54:31 +0000
Module Name: pkgsrc
Committed By: leot
Date: Thu Feb 28 10:54:31 UTC 2019
Modified Files:
pkgsrc/doc/guide/files: ftp-layout.xml
Log Message:
guide: Improve/extend documentation about FTP layout
- Document the `current', `stable' and `pkgsrc-20xxQy' more extensively,
from J. Lewis Muir via PR pkg/54019. Thanks!
- Refers to `pkgsrc.tar.{bz,gz,xz}' instead of just `pkgsrc.tar.gz' to
cover all compressed formats.
- Document `pkgsrc-readmes.tar.{bz,gz,xz}'
To generate a diff of this commit:
cvs rdiff -u -r1.14 -r1.15 pkgsrc/doc/guide/files/ftp-layout.xml
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
State-Changed-From-To: open->closed
State-Changed-By: leot@NetBSD.org
State-Changed-When: Thu, 28 Feb 2019 10:58:20 +0000
State-Changed-Why:
I have applied all your suggestions and while here also
documented the {.bz,.xz} tarballs and pkgsrc-readmes.tar.{bz,gz,xz}.
Thank you J. Lewis for the PR and suggestions!
>Unformatted:
(Contact us)
$NetBSD: query-full-pr,v 1.51 2026/08/10 02:28:17 riastradh Exp $
$NetBSD: gnats_config.sh,v 1.10 2026/05/13 22:00:09 riastradh Exp $
Copyright © 1994-2026
The NetBSD Foundation, Inc. ALL RIGHTS RESERVED.