NetBSD-Bugs archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

misc/46012: particularly unhelpful documentation



>Number:         46012
>Category:       misc
>Synopsis:       particularly unhelpful documentation
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sun Feb 12 22:10:00 +0000 2012
>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.



Home | Main Index | Thread Index | Old Index