From k-horik@yk.rim.or.jp Sun Nov 28 05:33:40 1999
Return-Path: <k-horik@yk.rim.or.jp>
Received: from mail.yk.rim.or.jp (mail.yk.rim.or.jp [202.247.130.37])
	by hub.freebsd.org (Postfix) with ESMTP id A112E14F82
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 28 Nov 1999 05:33:38 -0800 (PST)
	(envelope-from k-horik@yk.rim.or.jp)
Received: from localhost (pppb30.yk.rim.or.jp [202.247.186.130])
	by mail.yk.rim.or.jp (8.8.8/3.6W-RIMNET-98-06-09) with ESMTP id WAA24744
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 28 Nov 1999 22:33:37 +0900 (JST)
Message-Id: <19991128223253U.k-horik@yk.rim.or.jp>
Date: Sun, 28 Nov 1999 22:32:53 +0900
From: horikawa@jp.FreeBSD.org
Sender: Kazuo Horikawa <k-horik@yk.rim.or.jp>
Reply-To: horikawa@jp.FreeBSD.org
To: FreeBSD-gnats-submit@freebsd.org
Subject: elf.5 typo fix
X-Send-Pr-Version: 3.2

>Number:         15139
>Category:       docs
>Synopsis:       elf.5 typo fix
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    chris
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Nov 28 05:40:01 PST 1999
>Closed-Date:    Tue Dec 7 14:45:45 PST 1999
>Last-Modified:  Tue Dec  7 14:46:13 PST 1999
>Originator:     Kazuo Horikawa
>Release:        FreeBSD 3.1-RELEASE i386
>Organization:
jpman project
>Environment:

	elf.5 from 3.3-19991127-STABLE
.\"     $FreeBSD: src/share/man/man5/elf.5,v 1.1.2.2 1999/10/31 04:02:25 green Exp $

>Description:

	o Two words (`This member') are repeated.
	o `exists' should be `exits', because .fini section should be
	  executed when a program is terminated.
	o Two sentences are repeated.
	o Descripotions for ELF[32|64]_ST_BIND, ELF[32|64]_ST_TYPO,
	  ELF[32|64]_ST_INFO are not correct (see
	  /usr/include/sys/elf32.h and /usr/include/sys/elf64.h for
	  confirmation).

>How-To-Repeat:

	$ man 5 elf

>Fix:
	
--- elf.5.eng.bak	Tue Nov 23 23:24:45 1999
+++ elf.5.eng	Tue Nov 23 23:07:36 1999
@@ -295,7 +295,7 @@
 This member holds the size in bytes of one entry in the file's program header
 table; all entries are the same size.
 .It Dv e_phnum
-This member This member holds the number of entries in the program header
+This member holds the number of entries in the program header
 table. Thus the product of
 .Sy e_phentsize
 and
@@ -807,7 +807,7 @@
 .Sy SHF_ALLOC .
 .It .fini
 This section holds executable instructions that contribute to the process
-termination code. When a program exists normally the system arranges to
+termination code. When a program exits normally the system arranges to
 execute the code in this section. This section is of type
 .Sy SHT_PROGBITS .
 The attributes used are
@@ -829,11 +829,6 @@
 execute the code in this section before calling the main program entry point.
 This section is of type
 .Sy SHT_PROGBITS .
-This section holds executable instructions that contribute to the process
-initialisation code. When a program starts to run the system arranges to
-execute the code in this section before calling the main program entry point.
-This section is of type
-.Sy SHT_PROGBITS .
 The attributes used are
 .Sy SHF_ALLOC
 and
@@ -890,7 +885,7 @@
 This section is of type
 .Sy SHT_RELA .
 .It .rodata
-This section hold read-only data that typically contributes to a
+This section holds read-only data that typically contributes to a
 non-writable segment in the process image. This section is of type
 .Sy SHT_PROGBITS .
 The attribute used is
@@ -1035,15 +1030,15 @@
 .It Dv ELF32_ST_BIND(info)
 or
 .Sy ELF64_ST_BIND(info)
-convert a binding and a type into a st_info value.
+extract a binding from a st_info value.
 .It Dv ELF64_ST_TYPE(info)
 or
 .Sy ELF32_ST_TYPE(info)
-extract a binding from a st_info value.
+extract a type from a st_info value.
 .It Dv ELF32_ST_INFO(bind, type)
 or
 .Sy ELF64_ST_INFO(bind, type)
-extract a type from a st_info value.
+convert a binding and a type into a st_info value.
 .El
 .El
 .Pp


>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->analyzed 
State-Changed-By: chris 
State-Changed-When: Mon Dec 6 19:25:34 PST 1999 
State-Changed-Why:  
Sent to the author for review. 


Responsible-Changed-From-To: freebsd-doc->chris 
Responsible-Changed-By: chris 
Responsible-Changed-When: Mon Dec 6 19:25:34 PST 1999 
Responsible-Changed-Why:  
Awaiting review from the author. 

From: Chris Costello <chris@calldei.com>
To: horikawa@jp.FreeBSD.org
Cc: FreeBSD-gnats-submit@FreeBSD.ORG, asmodai@wxs.nl
Subject: Re: docs/15139: elf.5 typo fix
Date: Mon, 06 Dec 1999 21:27:12 -0600

 On Sun, Nov 28, 1999, horikawa@jp.FreeBSD.org wrote:
 > --- elf.5.eng.bak	Tue Nov 23 23:24:45 1999
 > +++ elf.5.eng	Tue Nov 23 23:07:36 1999
 
    Jeroen, can you look at this and tell me if it's right before
 I commit it?
 
 > @@ -295,7 +295,7 @@
 >  This member holds the size in bytes of one entry in the file's program header
 >  table; all entries are the same size.
 >  .It Dv e_phnum
 > -This member This member holds the number of entries in the program header
 > +This member holds the number of entries in the program header
 >  table. Thus the product of
 >  .Sy e_phentsize
 >  and
 > @@ -807,7 +807,7 @@
 >  .Sy SHF_ALLOC .
 >  .It .fini
 >  This section holds executable instructions that contribute to the process
 > -termination code. When a program exists normally the system arranges to
 > +termination code. When a program exits normally the system arranges to
 >  execute the code in this section. This section is of type
 >  .Sy SHT_PROGBITS .
 >  The attributes used are
 > @@ -829,11 +829,6 @@
 >  execute the code in this section before calling the main program entry point.
 >  This section is of type
 >  .Sy SHT_PROGBITS .
 > -This section holds executable instructions that contribute to the process
 > -initialisation code. When a program starts to run the system arranges to
 > -execute the code in this section before calling the main program entry point.
 > -This section is of type
 > -.Sy SHT_PROGBITS .
 >  The attributes used are
 >  .Sy SHF_ALLOC
 >  and
 > @@ -890,7 +885,7 @@
 >  This section is of type
 >  .Sy SHT_RELA .
 >  .It .rodata
 > -This section hold read-only data that typically contributes to a
 > +This section holds read-only data that typically contributes to a
 >  non-writable segment in the process image. This section is of type
 >  .Sy SHT_PROGBITS .
 >  The attribute used is
 > @@ -1035,15 +1030,15 @@
 >  .It Dv ELF32_ST_BIND(info)
 >  or
 >  .Sy ELF64_ST_BIND(info)
 > -convert a binding and a type into a st_info value.
 > +extract a binding from a st_info value.
 >  .It Dv ELF64_ST_TYPE(info)
 >  or
 >  .Sy ELF32_ST_TYPE(info)
 > -extract a binding from a st_info value.
 > +extract a type from a st_info value.
 >  .It Dv ELF32_ST_INFO(bind, type)
 >  or
 >  .Sy ELF64_ST_INFO(bind, type)
 > -extract a type from a st_info value.
 > +convert a binding and a type into a st_info value.
 >  .El
 >  .El
 >  .Pp
 
 -- 
 |Chris Costello <chris@calldei.com>
 |women.tar.gz:  A great program, but it doesn't come with documentation...
 `-------------------------------------------------------------------------
 

From: Jeroen Ruigrok/Asmodai <asmodai@wxs.nl>
To: Chris Costello <chris@calldei.com>
Cc: horikawa@jp.FreeBSD.org, FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: docs/15139: elf.5 typo fix
Date: Tue, 7 Dec 1999 22:06:48 +0100

 -On [19991207 06:58], Chris Costello (chris@calldei.com) wrote:
 >On Sun, Nov 28, 1999, horikawa@jp.FreeBSD.org wrote:
 
 >   Jeroen, can you look at this and tell me if it's right before
 >I commit it?
 
 See below.
 
 >> @@ -295,7 +295,7 @@
 >> -This member This member holds the number of entries in the program header
 >> +This member holds the number of entries in the program header
 
 Agreed.  Typo which no-one spotted even after proofreading.  Funny.  =)
 
 >> @@ -807,7 +807,7 @@
 >> -termination code. When a program exists normally the system arranges to
 >> +termination code. When a program exits normally the system arranges to
 
 Bah.  Another typo.  ACK.
 
 >> @@ -829,11 +829,6 @@
 >> -This section holds executable instructions that contribute to the process
 >> -initialisation code. When a program starts to run the system arranges to
 >> -execute the code in this section before calling the main program entry point.
 >> -This section is of type
 >> -.Sy SHT_PROGBITS .
 
 Eeks!  That's one lame mistake.  Can't believe how I missed it.  I've
 read my text at least 20 times in full version.  ACK.
 
 >> @@ -890,7 +885,7 @@
 >> -This section hold read-only data that typically contributes to a
 >> +This section holds read-only data that typically contributes to a
 
 Typo galore.  ACK.
 
 >> @@ -1035,15 +1030,15 @@
 >>  .It Dv ELF32_ST_BIND(info)
 >>  or
 >>  .Sy ELF64_ST_BIND(info)
 >> -convert a binding and a type into a st_info value.
 >> +extract a binding from a st_info value.
 >>  .It Dv ELF64_ST_TYPE(info)
 >>  or
 >>  .Sy ELF32_ST_TYPE(info)
 >> -extract a binding from a st_info value.
 >> +extract a type from a st_info value.
 >>  .It Dv ELF32_ST_INFO(bind, type)
 >>  or
 >>  .Sy ELF64_ST_INFO(bind, type)
 >> -extract a type from a st_info value.
 >> +convert a binding and a type into a st_info value.
 
 ACK.
 
 -- 
 Jeroen Ruigrok van der Werven/Asmodai           asmodai@[wxs.nl|bart.nl]
 Documentation nutter.          *BSD: Technical excellence at its best...  
 The BSD Programmer's Documentation Project <http://home.wxs.nl/~asmodai>
 Atone me to my throes curtail...
 
State-Changed-From-To: analyzed->closed 
State-Changed-By: chris 
State-Changed-When: Tue Dec 7 14:45:45 PST 1999 
State-Changed-Why:  
Patch applied. 
>Unformatted:
