Bug 38537

On Sat, May 25, 2002 at 12:01:25PM +0200, Marc Fonvieille wrote:

> >Description:
> In installation chapter of the handbook "sysinstall" application name
> should be always "Sysinstall". Read the patch below for more details.

Not to start a holy way, but it shouldn't.
charnier has been doing a lot of work in removing thing like "Ls" and "Rm"
from manpages, so I think we should follow that line.

I am, of course, open to being shouted down on this.

Ceri

-- 
get the cool shoe shine

I'm not quite sure I follow the reasoning for always capitalizing sysinstall.  I
can see where it might be capitilized at the beginning of a sentence but try to
avoid that to prevent confusion on how to invoke the command.

I would think that if it were a command, it should be shown exactly as it
would be invoked.  Perhaps I'm missing something here.

Randy


On Sat, 25 May 2002 12:01:25 +0200 (CEST)
Marc Fonvieille <marc@blackend.org> wrote:

> 
> >Number:         38537
> >Category:       docs
> >Synopsis:       In installation chapter of the handbook "sysinstall" application name should be always "Sysinstall"
> >Confidential:   no
> >Severity:       non-critical
> >Priority:       low
> >Responsible:    freebsd-doc
> >State:          open
> >Quarter:        
> >Keywords:       
> >Date-Required:
> >Class:          doc-bug
> >Submitter-Id:   current-users
> >Arrival-Date:   Sat May 25 03:10:06 PDT 2002
> >Closed-Date:
> >Last-Modified:
> >Originator:     Marc Fonvieille
> >Release:        FreeBSD 4.6-PRERELEASE i386
> >Organization:
> >Environment:
> System: FreeBSD abigail.blackend.org 4.6-PRERELEASE FreeBSD 4.6-PRERELEASE #5: Sun May 12 00:30:43 CEST 2002 marc@abigail.blackend.org:/usr/src/sys/compile/ABIGAIL i386
> 
> 
> 	
> >Description:
> In installation chapter of the handbook "sysinstall" application name
> should be always "Sysinstall". Read the patch below for more details.
> 	
> >How-To-Repeat:
> 	
> >Fix:
> Apply the patch to handbook/install/chapter.sgml
> 	
> 
> --- chapter.sgml.diff begins here ---
> --- chapter.sgml.org	Sat May 25 11:53:38 2002
> +++ chapter.sgml	Sat May 25 11:56:47 2002
> @@ -19,7 +19,7 @@
>        <author>
>  	<firstname>Randy</firstname>
>  	<surname>Pratt</surname>
> -	<contrib>The sysinstall walkthrough, screenshots, and general
> +	<contrib>The Sysinstall walkthrough, screenshots, and general
>  	  copy by </contrib>
>        </author>
>      </authorgroup>
> @@ -1151,7 +1151,7 @@
>  	them correctly.</para>
>  
>        <para>If you need to make changes to the UserConfig device probing,
> -	its easy to exit the <application>sysinstall</application> program
> +	its easy to exit the <application>Sysinstall</application> program
>  	and start over again.  Its also a good way to become more familiar
>  	with the process.</para>
>  
> @@ -4548,7 +4548,7 @@
>        in the FreeBSD Hardware Notes.  This document can usually be found in a
>        file named <filename>HARDWARE.TXT</filename>, in the top-level directory
>        of a CDROM or FTP distribution or in
> -      <application>sysinstall</application>'s documentation menu.  It lists,
> +      <application>Sysinstall</application>'s documentation menu.  It lists,
>        for a given architecture, what hardware devices are known to be
>        supported by each release of FreeBSD.</para>
>    </sect1>
> --- chapter.sgml.diff ends here ---
> 
> 
> >Release-Note:
> >Audit-Trail:
> >Unformatted:
> 
> To Unsubscribe: send mail to majordomo@FreeBSD.org
> with "unsubscribe freebsd-doc" in the body of the message

On Sat, May 25, 2002 at 09:19:06AM -0400, Randy Pratt wrote:
> I would think that if it were a command, it should be shown exactly as it
> would be invoked.  Perhaps I'm missing something here.
> 
As i said in my reply to Ceri for docs/38540 (which is about the same
problem), when sysinstall is used as a command we have
<command>/stand/sysinstall</command>, and as an application most of time
we have <application>Sysinstall</application>. We can see the same for
many apps: fdisk (FDisk), disklabel...

What is the best solution/convention?

Marc

Comment 4 Ceri Davies 2002-06-09 12:25:24 UTC

State Changed
From-To: open->closed

Superceded by docs/38540.