Bug 74477

Summary: [patch] Correct several links in the contributing article
Product: Documentation Reporter: Joel Dahl <joel>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
contlinks.diff none

Description Joel Dahl 2004-11-28 13:20:22 UTC
Fix five dead links:
- 1-4: &url.base;{place} points to /usr/share/{place} on my machine, which
       results in dead links.
- 5:   index.html should be article.html.
Comment 1 Ceri Davies 2004-11-28 17:08:12 UTC
On Sun, Nov 28, 2004 at 02:11:42PM +0100, Joel Dahl wrote:

> Fix five dead links:
> - 1-4: &url.base;{place} points to /usr/share/{place} on my machine, which
>        results in dead links.

> @@ -180,7 +180,7 @@
>  	<listitem>
>  	  <para>Get copies of formal standards like &posix;.  You can
>  	    get some links about these standards at the <ulink
> -	    url="&url.base;/projects/c99/index.html">FreeBSD
> +	    url="http://www.FreeBSD.org/projects/c99/index.html">FreeBSD
>  	    C99 & POSIX Standards Conformance Project</ulink> web
>  	    site. Compare FreeBSD's behavior to that required by the
>  	    standard. If the behavior differs, particularly in subtle

Hmm.  This is not right.  There should be a better way to specify that a
url is part of the web build and will not be present locally when the
docs are built.  Perhaps we can make URLS_ABSOLUTE=yes the default and
override it during a web build?

> - 5:   index.html should be article.html.

Why?

Ceri
-- 
Only two things are infinite, the universe and human stupidity, and I'm
not sure about the former.			  -- Einstein (attrib.)
Comment 2 Joel Dahl 2004-11-28 20:59:39 UTC
On Sun, 2004-11-28 at 17:10 +0000, Ceri Davies wrote: 
>  > @@ -180,7 +180,7 @@
>  >  	<listitem>
>  >  	  <para>Get copies of formal standards like &posix;.  You can
>  >  	    get some links about these standards at the <ulink
>  > -	    url="&url.base;/projects/c99/index.html">FreeBSD
>  > +	    url="http://www.FreeBSD.org/projects/c99/index.html">FreeBSD
>  >  	    C99 & POSIX Standards Conformance Project</ulink> web
>  >  	    site. Compare FreeBSD's behavior to that required by the
>  >  	    standard. If the behavior differs, particularly in subtle
>  
>  Hmm.  This is not right.  There should be a better way to specify that a
>  url is part of the web build and will not be present locally when the
>  docs are built.  Perhaps we can make URLS_ABSOLUTE=yes the default and
>  override it during a web build?


Yes, I agree, there should be a better way to achieve this. My patch
does not correct the real problem, it only avoids it.

>  
>  > - 5:   index.html should be article.html.
>  
>  Why?


Ahh, I'm obviously missing something here. index.html does not exist on
my machine (yes, I know that it works on the web). I'm clearly doing
something wrong during the doc build, since the [Single HTML / Split
HTML] option is gone.
Comment 3 gad 2006-03-17 15:49:03 UTC
>......
>......
>>  > @@ -180,7 +180,7 @@
>>  >  <listitem>
>>  >    <para>Get copies of formal standards like &posix;.  You can
>>  >      get some links about these standards at the <ulink
>>  > -    url=3D"&url.base;/projects/c99/index.html">FreeBSD
>>  > +
>>  > url=3D"http://www.FreeBSD.org/projects/c99/index.html">FreeBSD
>>  >      C99 & POSIX Standards Conformance Project</ulink> web
>>  >      site. Compare FreeBSD's behavior to that required by the
>>  >      standard. If the behavior differs, particularly in subtle
>>
>>  Hmm.  This is not right.  There should be a better way to specify
>>  that a
>>  url is part of the web build and will not be present locally when
>>  the
>>  docs are built.  Perhaps we can make URLS_ABSOLUTE= yes the default
>>  and
>>  override it during a web build?
> 
>Yes, I agree, there should be a better way to achieve this. My patch
>does not correct the real problem, it only avoids it.

I dissagre.
Why should something strange and difficult be invented?

As I can understand, there are no advantages in using `'&url.base;/.....`'
for www/ content.  Simple using absolute dns names
everywhere in references to web-site content (not doc/ tree) seems to be
more superior and easy solution.

-- 
Vitaly
Comment 4 Ceri Davies 2006-03-19 18:32:12 UTC
On 17/3/06 17:00, "Vitaly Bogdanov" <gad@gad.glazov.net> wrote:

>  As I can understand, there are no advantages in using `'&url.base;/.....`'
>  for www/ content.  Simple using absolute dns names
>  everywhere in references to web-site content (not doc/ tree) seems to be
>  more superior and easy solution.

That breaks mirroring.

Ceri
-- 
That must be wonderful!  I don't understand it at all.
                                      -- Moliere
Comment 5 gad 2006-03-20 07:04:58 UTC
On Sun, Mar 19, 2006, Ceri Davies wrote:
> The following reply was made to PR docs/74477; it has been noted by GNATS.
> 
> From: Ceri Davies <ceri@submonkey.net>
> To: Vitaly Bogdanov <gad@gad.glazov.net>,
> 	<freebsd-gnats-submit@freebsd.org>
> Cc:  
> Subject: Re: docs/74477: [patch] Correct several links in the contributing
>  article
> Date: Sun, 19 Mar 2006 18:32:12 +0000
> 
>  On 17/3/06 17:00, "Vitaly Bogdanov" <gad@gad.glazov.net> wrote:
>  
>  >  As I can understand, there are no advantages in using `'&url.base;/.....`'
>  >  for www/ content.  Simple using absolute dns names
>  >  everywhere in references to web-site content (not doc/ tree) seems to be
>  >  more superior and easy solution.
>  
>  That breaks mirroring.

But we use absolute dns names in many (maybe in all) FDP documents.
-- 
Vitaly
Comment 6 Ceri Davies 2006-03-20 09:26:11 UTC
On Mon, Mar 20, 2006 at 11:04:58AM +0400, Vitaly Bogdanov wrote:
> On Sun, Mar 19, 2006, Ceri Davies wrote:
> > The following reply was made to PR docs/74477; it has been noted by GNATS.
> > 
> > From: Ceri Davies <ceri@submonkey.net>
> > To: Vitaly Bogdanov <gad@gad.glazov.net>,
> > 	<freebsd-gnats-submit@freebsd.org>
> > Cc:  
> > Subject: Re: docs/74477: [patch] Correct several links in the contributing
> >  article
> > Date: Sun, 19 Mar 2006 18:32:12 +0000
> > 
> >  On 17/3/06 17:00, "Vitaly Bogdanov" <gad@gad.glazov.net> wrote:
> >  
> >  >  As I can understand, there are no advantages in using `'&url.base;/.....`'
> >  >  for www/ content.  Simple using absolute dns names
> >  >  everywhere in references to web-site content (not doc/ tree) seems to be
> >  >  more superior and easy solution.
> >  
> >  That breaks mirroring.
> 
> But we use absolute dns names in many (maybe in all) FDP documents.

Actually, we try hard not to.  That's why &base; and &enbase; exist.

Ceri
-- 
That must be wonderful!  I don't understand it at all.
                                                  -- Moliere
Comment 7 Remko Lodder freebsd_committer freebsd_triage 2006-10-13 08:35:43 UTC
State Changed
From-To: open->closed

As far as I can see, this problem is solved (I have no issues when browsing the article.html file). 
Joel, please let me know when this is not true.