Bug 35011

Summary: There are no commands called "diskless" or "jail".
Product: Documentation Reporter: Ken Stailey <kstailey>
Component: Books & ArticlesAssignee: ru <ru>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Ken Stailey 2002-02-16 21:50:01 UTC
IMHO, the intro(8) manpage should be edited to say "command and procedures" not just "commands"  There are no commands called "diskless" or "jail".

Fix: 

change intro(8) manpage from

     intro - introduction to system maintenance and operation commands

to

     intro - introduction to system administration commands and procedures
How-To-Repeat: 	N/A
Comment 1 chris freebsd_committer freebsd_triage 2002-02-16 21:54:42 UTC
On Saturday, February 16, 2002, Ken Stailey wrote:
> >Synopsis:       There are no commands called "diskless" or "jail".

   Actually, there is a command called `jail'.  However,
diskless(8) should probably become diskless(7).

-- 
+-------------------+---------------------------------------------------------+
| Chris Costello    | Be moderate where pleasure is concerned, avoid fatigue. |
| chris@FreeBSD.org |                                                         |
+-------------------+---------------------------------------------------------+
Comment 2 Ken Stailey 2002-02-16 21:59:35 UTC
Chris Costello wrote:

>On Saturday, February 16, 2002, Ken Stailey wrote:
>
>>>Synopsis:       There are no commands called "diskless" or "jail".
>>>
>
>   Actually, there is a command called `jail'.  However,
>diskless(8) should probably become diskless(7).
>
Fine with me.
Comment 3 Murray Stokely freebsd_committer freebsd_triage 2002-03-28 09:43:32 UTC
State Changed
From-To: open->analyzed

diskless should be moved to man7.  I've asked Ruslan for his approval 
before requesting this from the CVS meisters.
Comment 4 chern freebsd_committer freebsd_triage 2002-07-29 12:16:26 UTC
Does anyone object in making this change?  Ken is trying to state that
section 8 contains more than just commands, eg: diskless(8), yp(8), etc.

The short description of intro(8) should be changed to reflect this.

- chern

Index: intro.8
===================================================================
RCS file: /home/ncvs/src/share/man/man8/intro.8,v
retrieving revision 1.3.2.3
diff -u -r1.3.2.3 intro.8
--- intro.8     12 Apr 2002 16:25:18 -0000      1.3.2.3
+++ intro.8     29 Jul 2002 11:14:26 -0000
@@ -37,7 +37,7 @@
 .Os
 .Sh NAME
 .Nm intro
-.Nd "introduction to system maintenance and operation commands"
+.Nd "introduction to system administration commands and procedures"
 .Sh DESCRIPTION
 This section contains information related to system operation
 and maintenance.


On Sat, 16 Feb 2002, Ken Stailey wrote:

>
> >Description:
> IMHO, the intro(8) manpage should be edited to say "command and
> procedures"  not just "commands"  There are no commands called
> "diskless" or "jail". >
> >How-To-Repeat:
> 	N/A
> >Fix:
>
> change intro(8) manpage from
>
>      intro - introduction to system maintenance and operation commands
>
> to
>
>      intro - introduction to system administration commands and procedures
>
>
Comment 5 Ken Stailey 2002-07-29 13:03:46 UTC
No, the intro should not be changed.  Those pages should be moved to 
section 7.

Chern Lee wrote:

>Does anyone object in making this change?  Ken is trying to state that
>section 8 contains more than just commands, eg: diskless(8), yp(8), etc.
>
>The short description of intro(8) should be changed to reflect this.
>
>- chern
>
>Index: intro.8
>===================================================================
>RCS file: /home/ncvs/src/share/man/man8/intro.8,v
>retrieving revision 1.3.2.3
>diff -u -r1.3.2.3 intro.8
>--- intro.8     12 Apr 2002 16:25:18 -0000      1.3.2.3
>+++ intro.8     29 Jul 2002 11:14:26 -0000
>@@ -37,7 +37,7 @@
> .Os
> .Sh NAME
> .Nm intro
>-.Nd "introduction to system maintenance and operation commands"
>+.Nd "introduction to system administration commands and procedures"
> .Sh DESCRIPTION
> This section contains information related to system operation
> and maintenance.
>
>
>On Sat, 16 Feb 2002, Ken Stailey wrote:
>
>  
>
>>>Description:
>>>      
>>>
>>IMHO, the intro(8) manpage should be edited to say "command and
>>procedures"  not just "commands"  There are no commands called
>>"diskless" or "jail". >
>>    
>>
>>>How-To-Repeat:
>>>      
>>>
>>	N/A
>>    
>>
>>>Fix:
>>>      
>>>
>>change intro(8) manpage from
>>
>>     intro - introduction to system maintenance and operation commands
>>
>>to
>>
>>     intro - introduction to system administration commands and procedures
>>
>>
>>    
>>
>
>
>
>  
>
Comment 6 simon 2003-05-01 00:35:24 UTC
Hello

To summerize this bug :

Several man pages from section 8 really should be moved to section 7
since section 7 should be for "system maintenance and operation
commands".

The ones I can find are (basically most of share/man/man8/) :

adding_user
crash
diskless
picobsd (this is strictly a command but hardly has anything to do with
	"system maintenance and operation commands").
sticky
yp

For the complete picture NetBSD appears to have modified their definition
of what should be in section 8 to accomodate man pages like diskless(8) :

     A number of pages in this section describe general system management top-
     ics. For example, the diskless(8) page describes how to boot a system
     over a network, and the compat_linux(8) page describes how to run Linux
     binaries on NetBSD architectures that support it.

OpenBSD still have diskless in section 8 but does not have generally noted
this in intro(8) but do have :

     The section `crash' should be consulted to understand how to interpret
     system crash dumps.

If the pages should be moved I can make the patch to update the relevant
references from man pages / docbook documents and so on.

My 0.02c is that this would be a good thing for consistency.

-- 
Simon L. Nielsen
Comment 7 simon 2003-05-01 00:45:20 UTC
On 2003.04.30 16:40:15 -0700, Simon L. Nielsen wrote:
>  Several man pages from section 8 really should be moved to section 7
>  since section 7 should be for "system maintenance and operation
>  commands".


Time to go to bed... It is of course section 8 which is "system
maintenance and operation commands" - secion 7 is "miscellaneous
information pages".

-- 
Simon L. Nielsen
Comment 8 dfilter service freebsd_committer freebsd_triage 2006-10-21 21:36:12 UTC
ru          2006-10-21 20:35:50 UTC

  FreeBSD src repository

  Modified files:
    share/man/man8       intro.8 
  Log:
  Make it clear that section 8 also documents system management
  procedures, not necessarily commands.
  
  PR:             docs/35011
  Obtained from:  NetBSD (partly)
  
  Revision  Changes    Path
  1.12      +28 -17    src/share/man/man8/intro.8
_______________________________________________
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 9 ru freebsd_committer freebsd_triage 2006-10-21 21:36:52 UTC
State Changed
From-To: analyzed->closed

The intro(8) manpage has been updated. 


Comment 10 ru freebsd_committer freebsd_triage 2006-10-21 21:36:52 UTC
Responsible Changed
From-To: freebsd-doc->ru
Comment 11 dfilter service freebsd_committer freebsd_triage 2006-10-27 12:03:50 UTC
ru          2006-10-27 11:03:35 UTC

  FreeBSD src repository

  Modified files:        (Branch: RELENG_6)
    share/man/man8       intro.8 
  Log:
  MFC: 1.12:
  
  Make it clear that section 8 also documents system management
  procedures, not necessarily commands.
  
  PR:             docs/35011
  Approved by:    re (blanket)
  
  Revision   Changes    Path
  1.11.12.1  +28 -17    src/share/man/man8/intro.8
_______________________________________________
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"