Bug 108676

Summary: [patch] fix several problems in the jail chapter in the arch-handbook
Product: Documentation Reporter: MQ <antinvidia>
Component: Books & ArticlesAssignee: Xin LI <delphij>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description MQ 2007-02-02 06:10:09 UTC 
There are several problems in the jail chapter of the arch-handbook. Some of them are typos, and others may be serious errors.

1. Typos. Many occurrences of '_' should be '.' and several occurrences of '.' should be '_'.
2. ntohl() translates IP address from network byte order to host byte order, but in arch-handbook, it is described as the reverse direction.
3. userland jail.c doesn't do a fork before the execv(3), but the arch-handbook says so.
4. I think the facility of the function prison_ip is misdescribed. This function returns 1 when the IP address doesn't belong to the calling jail, returns 0 otherwise. But the arch-handbook describes in contrast with my opinion again.

At last I modified the whole chapter to keep everything consistent with 6.1-RELEASE at least(most of the codes remains the same in 6.2-RELEASE).

Fix: Here is the diff output against the original file.
Original version is      
$FreeBSD: /repoman/r/dcvs/doc/en_US.ISO8859-1/books/arch-handbook/jail/chapter.sgml,v 1.19 2007/01/31 14:22:22 delphij Exp $
Comment 1 Xin LI freebsd_committer freebsd_triage 2007-05-15 03:10:29 UTC 
Responsible Changed
From-To: freebsd-doc->delphij

Grab (prodded by submitter)
Comment 2 dfilter service freebsd_committer freebsd_triage 2007-05-15 03:39:50 UTC 
delphij     2007-05-15 02:39:44 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/arch-handbook/jail chapter.sgml 
  Log:
  Correct several typos, etc. in jail chapter:
   - Correct misuse of '.' and '_'
   - ntohl() converts from network order to host order,
     which is described oppositely.
   - Userland jail.c does not do fork() before execve(),
     reflect the fact.
   - prison_ip() returns 0 when IP is owned by the current
     jail, and the arch handbook describes the opposite.
  
  Submitted by:   MQ <nodummy yeah net>
  PR:             docs/108676
  
  Revision  Changes    Path
  1.20      +236 -188  doc/en_US.ISO8859-1/books/arch-handbook/jail/chapter.sgml
_______________________________________________
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 3 Xin LI freebsd_committer freebsd_triage 2007-05-15 03:40:44 UTC 
State Changed
From-To: open->closed

Committed, thanks!