Bug 32468

Summary: broken link in handbook: sysutils/mkisofs
Product: Documentation Reporter: Wolfram Schneider <wosch>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Wolfram Schneider freebsd_committer freebsd_triage 2001-12-03 13:50:00 UTC
Date: Mon, 19 Nov 2001 23:39:56 -0800 (PST)
From: Todd Greenwood-Geer <tgreenwoodgeer@yahoo.com>
Subject: sysutils/mkisofs
To: www@FreeBSD.ORG


This page is hosting a broken link for:

sysutils/mkisofs

PAGE:
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/creating-cds.html

BROKEN LINK:
http://www.freebsd.org/cgi/url.cgi?ports/sysutils/mkisofs/pkg-descr

NOTES:
the function can be found at:

ftp://ftp.freebsd.org/pub/FreeBSD/branches/-current/ports/sysutils/mkisofs/

-Todd
Comment 1 phantom 2001-12-03 13:59:01 UTC
hi,

On Mon, Dec 03, 2001 at 05:48:26AM -0800, wolfram schneider wrote:
> 
> >Number:         32468
> >Category:       docs
> >Synopsis:       broken link in handbook: sysutils/mkisofs
 
> This page is hosting a broken link for:
> 
> sysutils/mkisofs
> 
> PAGE:
> http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/creating-cds.html
> 
> BROKEN LINK:
> http://www.freebsd.org/cgi/url.cgi?ports/sysutils/mkisofs/pkg-descr

Root of problem is that mkisofs is slave port of cdrecord and has not own
pkg-descr. Correct link should look like
..?ports/sysutils/cdrtools/pkg-descr.mkisofs, but current there's no
simple way to do it in docbook :-(

To fix this problem someone should rewrite this section in order to
mention cdrtools port istead of mkisofs or directly use correct
reference to pkg-descr.mkisofs file.
Comment 2 hiten pandya 2001-12-11 11:49:15 UTC
i have made a patch which resolves the issue, the way
i have done it is:

- it is not possible to directly link to a port,
so, i had to remove a sentence from the section and
add a <note> which explains how to install the new
mkisofs which, is under sysutils/cdrtools....

i have a patch here...

=Hiten
=<hiten@uk.FreeBSD.org>

*** chapter.sgml.old Tue Dec 11 11:16:26 2001
--- chapter.sgml Tue Dec 11 11:35:20 2001
***************
*** 731,738 ****
<para>The <command><link
linkend="mkisofs">mkisofs</link></command>
program is used to produce a data file containing an
ISO 9660 file
system. It has options that support various
extensions, and is
! described below. You can install it with the 
! <port>sysutils/mkisofs</port> port.</para>

<indexterm>
<primary>CD burner</primary>
--- 731,737 ----
<para>The <command><link
linkend="mkisofs">mkisofs</link></command>
program is used to produce a data file containing an
ISO 9660 file
system. It has options that support various
extensions, and is
! described below.</para>

<indexterm>
<primary>CD burner</primary>
***************
*** 749,754 ****
--- 748,762 ----
supported drives. To find out if a drive is supported,
see
<ulink url="http://freebsd.dk/ata/">CD-R/RW supported
drives</ulink>.</para>
+ 
+ <note>
+ <para>The <application>mkisofs</application> tool is
now part of
+ <port>sysutils/cdrtools</port> port. All references
to 
+ <filename>sysutils/mkisofs</filename> should be
updated to the
+ later one (<filename>sysutils/cdrtools</filename>);
i.e. you will
+ need to install <port>sysutils/cdrtools</port>
inorder to use
+ <application>mkisofs</application>.</para>
+ </note>
</sect2>

<sect2 id="mkisofs">




=====
-Hiten,

Thank You,
Yours Sincerely,
Hiten Pandya,
<hiten@uk.freebsd.org>
<http://www.geocities.com/hitmaster2k>

__________________________________________________
Do You Yahoo!?
Check out Yahoo! Shopping and Yahoo! Auctions for all of
your unique holiday gifts! Buy at http://shopping.yahoo.com
or bid at http://auctions.yahoo.com
Comment 3 hiten pandya 2001-12-11 17:27:50 UTC
the above patch states the change incorrectly, please use this patch
in-order to
get the right result.

--- chapter.sgml        Sat Dec  8 12:08:40 2001
+++ chapter.sgml.new    Tue Dec 11 17:20:30 2001
@@ -732,7 +732,15 @@
        program is used to produce a data file containing an ISO 9660
file
        system. It has options that support various extensions, and is
        described below. You can install it with the 
-       <port>sysutils/mkisofs</port> port.</para>
+       <port>sysutils/cdrtools</port> port.</para>
+
+      <note>
+        <para>The <application>mkisofs</application> is part of
<port>cdrtools
+       </port>.  Inorder to install <application>mkisofs</application>
you
+       will need to install <port>sysutils/cdrtools</port>.  Although
the
+       <filename>sysutils/mkisofs</filename>> still exists but cannot
be 
+       refrenced directly.</para>
+      </note>
     
       <indexterm>
         <primary>CD burner</primary>


The Patch above will show the user why to install sysutils/cdrtools and
why 
sysutils/mkisofs cannot be referenced directly.

=Hiten
=<hiten@uk.FreeBSD.org>
Comment 4 Peter Pentchev 2001-12-11 17:32:58 UTC
On Tue, Dec 11, 2001 at 05:27:50PM +0000, Hiten Pandya wrote:
> the above patch states the change incorrectly, please use this patch
> in-order to
> get the right result.
> 
> --- chapter.sgml        Sat Dec  8 12:08:40 2001
> +++ chapter.sgml.new    Tue Dec 11 17:20:30 2001
> @@ -732,7 +732,15 @@
>         program is used to produce a data file containing an ISO 9660
> file
>         system. It has options that support various extensions, and is
>         described below. You can install it with the 
> -       <port>sysutils/mkisofs</port> port.</para>
> +       <port>sysutils/cdrtools</port> port.</para>
> +
> +      <note>
> +        <para>The <application>mkisofs</application> is part of
> <port>cdrtools
> +       </port>.  Inorder to install <application>mkisofs</application>
> you
> +       will need to install <port>sysutils/cdrtools</port>.  Although
> the
> +       <filename>sysutils/mkisofs</filename>> still exists but cannot
> be 
> +       refrenced directly.</para>
> +      </note>
>      
>        <indexterm>
>          <primary>CD burner</primary>
> 
> 
> The Patch above will show the user why to install sysutils/cdrtools and
> why 
> sysutils/mkisofs cannot be referenced directly.

Uh.  I only meant that it could not be referenced directly
in the web-site documentation, because the <port> tag links
to a pkg-descr file, which is non-existant in this case.

In general, the sysutils/mkisofs port is a very much viable
and used way to get mkisofs working.  As a matter of fact,
the src/release/i386/mkisoimages.sh script, used to build
ISO images of the FreeBSD releases, tries to install exactly
the sysutils/mkisofs port if no mkisofs binary is found
on the system.

IMHO, the correct fix in this case should be to fix the doc
markup scheme, so that the <port> tag allows linking to another
file instead of pkg-descr.  I'll look into this later today.
This would let us reference the mkisofs port properly.

G'luck,
Peter

-- 
This sentence claims to be an Epimenides paradox, but it is lying.
Comment 5 Marc Fonvieille freebsd_committer freebsd_triage 2002-06-29 21:34:49 UTC
State Changed
From-To: open->closed

The broken link was fixed.