Bug 154931

Summary: handbook/install/chapter.sgml - repeated chunk of text
Product: Documentation Reporter: Taras Korenko <ds>
Component: Books & ArticlesAssignee: Johann Kois <jkois>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Taras Korenko 2011-02-21 09:40:09 UTC
  doc/en_US.ISO8859-1/books/handbook/install/chapter.sgml - repeated chunk of text since rev. 1.417
  As of current revision (1.419) it can be found at the following lines:
1) 639-645, 647-648
vs.
2) 650-656, 661-663

Fix: skip lines 647-656 from *.sgml source

Patch attached with submission follows:
How-To-Repeat: Check this output: http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/install-pre.html , find '2.3.7 Prepare the Boot Media', compare two <warning></warning> blocks.
Comment 1 Johann Kois freebsd_committer freebsd_triage 2011-02-21 09:45:35 UTC
Responsible Changed
From-To: freebsd-doc->jkois

Take this one.
Comment 2 Johann Kois freebsd_committer freebsd_triage 2011-02-21 11:16:59 UTC
Hm.  The whole section is a little bit "fishy".

As mentioned the 2 warnings are "basically" the same, although the 
wording is a little bit different.

Another example: It says "Windows drive H: in the following example", 
but H: is never ever mentioned again.  Actually there is no example at 
all...

I will take a closer look at that.

jkois

-- 
  Johann Kois
  jkois(at)FreeBSD.org
  FreeBSD Documentation Project
  FreeBSD German Documentation Project - https://doc.bsdgroup.de
Comment 3 Warren Block 2011-02-21 14:44:18 UTC
I did reply to keramida@ earlier about this problem with 154837, but 
neglected to include bug-followup@FreeBSD.org.  Here's the message, 
along with a patch that fixes a couple of other problems.

---------- Forwarded message ----------
Date: Thu, 17 Feb 2011 08:17:39
From: Warren Block <wblock@wonkity.com>
To: keramida@FreeBSD.org
Subject: Re: docs/154837: [patch] update Handbook for writing memstick image
     with Windows

On Thu, 17 Feb 2011, keramida@FreeBSD.org wrote:

> Synopsis: [patch] update Handbook for writing memstick image with Windows
> 
> State-Changed-From-To: open->closed
> State-Changed-By: keramida
> State-Changed-When: Thu Feb 17 09:20:55 UTC 2011
> State-Changed-Why:
> Committed, in revision 1.417 of handbook/install/chapter.sgml
> 
> Thanks!
> 
> http://www.freebsd.org/cgi/query-pr.cgi?pr=154837

The patch didn't quite apply as planned; there's a duplicate section at the 
start of the FreeBSD procedure (two warnings, and the sysctl line). Possibly 
due to the original having changed since the patch was created.

Two other notes: the Windows section warns about the H: drive shown in the 
example, which is not actually shown, and the link should probably go to the 
project page, not a direct download that may be outdated.

The following patch applies to the latest source to correct these three things.

--- en_US.ISO8859-1/books/handbook/install/chapter.sgml.orig	2011-02-17 
08:07:54.000000000 -0700
+++ en_US.ISO8859-1/books/handbook/install/chapter.sgml	2011-02-17 
08:12:24.000000000 -0700
@@ -644,17 +644,6 @@
  		may destroy your existing data.</para>
  	    </warning>

-	    <para>Set the <varname>kern.geom.debugflags</varname> sysctl to be
-	      able to write a master boot record to the target device.</para>
-
-	    <warning>
-	      <para>The example below
-		lists <filename class="devicefile">/dev/da0</filename> as the
-		target device where the image will be written. Be very careful
-		that you have the correct device as the output target, or you
-		may destroy your existing data.</para>
-	    </warning>
-
  	    <step>
  	      <title>Writing the Image with &man.dd.1;</title>

@@ -679,11 +668,8 @@
  	    <title>Using &windows To Write the Image</title>

  	    <warning>
-	      <para>The example below
-	        lists <filename class="devicefile">H:</filename> as the drive
-	        letter of the device where the image will be written.  Be very
-	        careful that you have the correct device as the output target,
-	        or you may destroy existing data.</para>
+	      <para>Make sure you use the correct drive letter as the output
+	        target, or you may overwrite and destroy existing data.</para>
  	    </warning>

  	    <step>
@@ -691,8 +677,8 @@

  	      <para><application>Image Writer for Windows</application> is a
  	        free application that can correctly write an image file to a
-	        memory stick.  Download it
-	        from <ulink 
url="http://launchpad.net/win32-image-writer/0.2/0.2/+download/win32diskimager-RELEASE-0.2-r23-win32.zip"></ulink>
+	        memory stick.  Download it from
+	        <ulink url="https://launchpad.net/win32-image-writer"></ulink>
  	        and extract it into a folder.</para>
  	    </step>
Comment 4 dfilter service freebsd_committer freebsd_triage 2011-02-22 20:57:46 UTC
jkois       2011-02-22 20:57:42 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/handbook/install chapter.sgml 
  Log:
  PR:     docs/154931
  
  Fix some problems/hickups in the "Prepare Boot Media" section.
  
  Problem found by:       Taras (ds ett ukrhub dott net)
  Patch provided by:      Warren Block (wblock ett wonkity dott com)
  
  Revision  Changes    Path
  1.420     +4 -18     doc/en_US.ISO8859-1/books/handbook/install/chapter.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 5 Johann Kois freebsd_committer freebsd_triage 2011-02-23 10:43:15 UTC
State Changed
From-To: open->closed

Changes to the handbook are online.  Close this PR. 

Thanks for pointing to this and also thanks for providing the patch to fix this.