NetBSD Problem Report #46012

From www@NetBSD.org  Sun Feb 12 22:06:30 2012
Return-Path: <www@NetBSD.org>
Received: from mail.netbsd.org (mail.netbsd.org [149.20.53.66])
	by www.NetBSD.org (Postfix) with ESMTP id 6091E63BCF4
	for <gnats-bugs@gnats.NetBSD.org>; Sun, 12 Feb 2012 22:06:30 +0000 (UTC)
Message-Id: <20120212220629.B071A63B86B@www.NetBSD.org>
Date: Sun, 12 Feb 2012 22:06:29 +0000 (UTC)
From: visitor@mailinator.com
Reply-To: visitor@mailinator.com
To: gnats-bugs@NetBSD.org
Subject: particularly unhelpful documentation
X-Send-Pr-Version: www-1.0

>Number:         46012
>Category:       misc
>Synopsis:       particularly unhelpful documentation
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    leot
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sun Feb 12 22:10:00 +0000 2012
>Closed-Date:    Mon Nov 21 05:38:49 +0000 2016
>Last-Modified:  Mon Nov 21 05:38:49 +0000 2016
>Originator:     visitor
>Release:        none
>Organization:
unorganized
>Environment:
refer to http://www.netbsd.org/docs/guide/en/chap-cgd.html
>Description:
http://www.netbsd.org/docs/guide/en/chap-cgd.html contains the following text:

[start quote]
14.4.1. Introduction

This section explains how to create and use encrypted CDs/DVDs with NetBSD (all I say about "CDs" here does also apply to "DVDs"). I assume that you have basic knowledge of cgd(4), so I will not explain what cgd is or what's inside it in detail. The same applies to vnd(4). One can make use of encrypted CDs after reading this howto, but for more detailed information about different cgd configuration options, please read [Chapter 14, The cryptographic device driver (CGD)] or the manpages.
[end quote]

The part between [ and ] (added) in the last sentence is actually a link to the same page. Thus, it says, for more information than is in the page you're reading, do look at this very page same again. Not the most helpful of comments.

At a guess, 14.4 is adapted from somewhere else, but it does mean that this bit needs copyediting to reword the section to be less insulting, however subtly, and more actually useful.
>How-To-Repeat:
refer to http://www.netbsd.org/docs/guide/en/chap-cgd.html
>Fix:
Copyediting left as an exercise.

>Release-Note:

>Audit-Trail:

Responsible-Changed-From-To: misc-bug-people->www
Responsible-Changed-By: wiz@NetBSD.org
Responsible-Changed-When: Mon, 13 Feb 2012 09:39:16 +0000
Responsible-Changed-Why:
webpage bug report


From: "Leonardo Taccari" <leot@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/46012 CVS commit: htdocs/docs/guide/en
Date: Fri, 11 Nov 2016 16:37:41 +0000

 Module Name:	htdocs
 Committed By:	leot
 Date:		Fri Nov 11 16:37:41 UTC 2016

 Modified Files:
 	htdocs/docs/guide/en: chap-cgd.xml

 Log Message:
 Delete `Example: encrypted CDs/DVDs - Introduction' section.

 It was a bit confusing and self-referential without providing useful
 information. The chapter provides a good introduction to cgd(4)
 and vnd(4) usage in the paragraph can be considered pretty self
 consistent.

 Pointed out by visitor via PR misc/46012.


 To generate a diff of this commit:
 cvs rdiff -u -r1.5 -r1.6 htdocs/docs/guide/en/chap-cgd.xml

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

Responsible-Changed-From-To: www->leot
Responsible-Changed-By: leot@NetBSD.org
Responsible-Changed-When: Fri, 11 Nov 2016 16:44:51 +0000
Responsible-Changed-Why:
Take


State-Changed-From-To: open->feedback
State-Changed-By: leot@NetBSD.org
State-Changed-When: Fri, 11 Nov 2016 16:44:51 +0000
State-Changed-Why:
I've deleted the introduction in -r1.6 of htdocs/docs/guide/en/chap-cgd.xml

visitor, is it clearer now?



State-Changed-From-To: feedback->closed
State-Changed-By: dholland@NetBSD.org
State-Changed-When: Mon, 21 Nov 2016 05:38:49 +0000
State-Changed-Why:
Assume that someone who posted from mailinator in 2012 isn't likely to
return and provide feedback four years later.


>Unformatted:

Home	PR Database Search