Bug 150098

Summary: [handbook] document naming conventions of jail names in handbook and rc.conf(5)
Product: Documentation Reporter: cc <cpt_complain>
Component: Books & ArticlesAssignee: Glen Barber <gjb>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description cc 2010-08-29 23:40:03 UTC
It should be mentioned in the Handbook

http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/jails.html

and the man pages

http://www.freebsd.org/cgi/man.cgi?query=jail&apropos=0&sektion=0&manpath=FreeBSD+8.1-RELEASE&format=html

that jail names should contain only numbers or letters.
Special characters and punctuation will confuse the parser.

How-To-Repeat: Try to create a jail with the name, for instance, jail-bird or jail_bird.
The initialization file rc.conf will produce error messages at boot time.
Comment 1 Volker Werth freebsd_committer freebsd_triage 2010-08-30 19:34:35 UTC
Responsible Changed
From-To: freebsd-bugs->freebsd-doc

over to the documentation team
Comment 2 Glen Barber freebsd_committer freebsd_triage 2010-09-04 19:59:11 UTC
Responsible Changed
From-To: freebsd-doc->gjb

I'll take it.
Comment 3 dfilter service freebsd_committer freebsd_triage 2010-09-04 21:19:35 UTC
gjb         2010-09-04 20:19:26 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/handbook/jails chapter.sgml 
  Log:
  Note in the Jails chapter that jail_list should contain only
  alphanumeric characters.
  
  PR:             docs/150098
  Submitted by:   cc (cpt_complain at yahoo dot com)
  Approved by:    jkois (co-mentor)
  
  Revision  Changes    Path
  1.21      +5 -0      doc/en_US.ISO8859-1/books/handbook/jails/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 4 Glen Barber freebsd_committer freebsd_triage 2010-09-04 21:31:33 UTC
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hello,

I have patched this chapter in the Handbook, and the change should be
visible within a few hours.  I am working on a similar fix for the man
pages, however rc.conf(5) may be a better location to note this, as it
is a rc-specific entry.

Best regards,

- -- 
Glen Barber
FreeBSD Documentation Project
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Darwin)

iQEcBAEBAgAGBQJMgqykAAoJEFJPDDeguUaj5c4IAKHf/VrfovDbXdVz2UDamqgg
Ws9w7T9fb+yseUja4zBqFHVykUaHeb/RkczL0h/AduOihX6qBtmksTZSu1PoeiHT
iIfhr8vgiBqr/SSPgjW69avsNzOjhCvv3jeBbqXAfdftaaAKd6pu5Dd5PUlx/ICs
namWLHv5ie1oAGMC9KgPyD0ZoN2F6Z4A438BfTAar4wSNCrOj7X7ktBH0aiTUA5o
T2tZ0MC1CtrmKkw+XMR4eR8ebvt5DvlMmDHwCYbCAjYINBNsFZtgkX34t/RzTR73
dxBKmfMxg6Wp9t/gO4/09xDGAdhYq6+xL3SM/5xsXiV+pp5MY2nNM5lwTPutPKQ=
=0caB
-----END PGP SIGNATURE-----
Comment 5 dfilter service freebsd_committer freebsd_triage 2010-09-05 21:05:12 UTC
Author: gjb (doc committer)
Date: Sun Sep  5 20:04:54 2010
New Revision: 212241
URL: http://svn.freebsd.org/changeset/base/212241

Log:
  Note in rc.conf(5) that jail_list should contain only alphanumeric
  characters.
  
  PR:		150098
  Submitted by:	cc (cpt_complain at yahoo dot com)
  Approved by:	keramida (mentor)
  MFC after:	1 week

Modified:
  head/share/man/man5/rc.conf.5

Modified: head/share/man/man5/rc.conf.5
==============================================================================
--- head/share/man/man5/rc.conf.5	Sun Sep  5 20:04:02 2010	(r212240)
+++ head/share/man/man5/rc.conf.5	Sun Sep  5 20:04:54 2010	(r212241)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd August 3, 2010
+.Dd September 4, 2010
 .Dt RC.CONF 5
 .Os
 .Sh NAME
@@ -3503,7 +3503,8 @@ A space separated list of names for jail
 This is purely a configuration aid to help identify and
 configure multiple jails.
 The names specified in this list will be used to
-identify settings common to an instance of a jail.
+identify settings common to an instance of a jail,
+and should contain alphanumeric characters only.
 Assuming that the jail in question was named
 .Li vjail ,
 you would have the following dependent variables:
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 6 Glen Barber freebsd_committer freebsd_triage 2010-09-05 21:05:35 UTC
State Changed
From-To: open->patched

Patched in HEAD.  MFC after 1 week.
Comment 7 dfilter service freebsd_committer freebsd_triage 2010-09-12 19:37:39 UTC
Author: gjb (doc committer)
Date: Sun Sep 12 18:37:34 2010
New Revision: 212503
URL: http://svn.freebsd.org/changeset/base/212503

Log:
  MFC 212241.
  
  Note that jail_list should contain alphanumeric characters only.
  
  PR:		150098
  Approved by:	keramida (mentor)

Modified:
  stable/8/share/man/man5/rc.conf.5

Modified: stable/8/share/man/man5/rc.conf.5
==============================================================================
--- stable/8/share/man/man5/rc.conf.5	Sun Sep 12 18:04:47 2010	(r212502)
+++ stable/8/share/man/man5/rc.conf.5	Sun Sep 12 18:37:34 2010	(r212503)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd April 14, 2010
+.Dd September 4, 2010
 .Dt RC.CONF 5
 .Os
 .Sh NAME
@@ -3402,7 +3402,8 @@ A space separated list of names for jail
 This is purely a configuration aid to help identify and
 configure multiple jails.
 The names specified in this list will be used to
-identify settings common to an instance of a jail.
+identify settings common to an instance of a jail,
+and should contain alphanumeric characters only.
 Assuming that the jail in question was named
 .Li vjail ,
 you would have the following dependent variables:
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 8 dfilter service freebsd_committer freebsd_triage 2010-09-12 19:51:02 UTC
Author: gjb (doc committer)
Date: Sun Sep 12 18:50:57 2010
New Revision: 212504
URL: http://svn.freebsd.org/changeset/base/212504

Log:
  MFC 212241.
  
  Note that jail_list should contain alphanumeric characters only.
  
  PR:		150098
  Approved by:	keramida (mentor)

Modified:
  stable/7/share/man/man5/rc.conf.5

Modified: stable/7/share/man/man5/rc.conf.5
==============================================================================
--- stable/7/share/man/man5/rc.conf.5	Sun Sep 12 18:37:34 2010	(r212503)
+++ stable/7/share/man/man5/rc.conf.5	Sun Sep 12 18:50:57 2010	(r212504)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd November 11, 2009
+.Dd September 4, 2010
 .Dt RC.CONF 5
 .Os
 .Sh NAME
@@ -3369,7 +3369,8 @@ A space separated list of names for jail
 This is purely a configuration aid to help identify and
 configure multiple jails.
 The names specified in this list will be used to
-identify settings common to an instance of a jail.
+identify settings common to an instance of a jail,
+and should contain alphanumeric characters only.
 Assuming that the jail in question was named
 .Li vjail ,
 you would have the following dependent variables:
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 9 Glen Barber freebsd_committer freebsd_triage 2010-09-12 19:54:39 UTC
State Changed
From-To: patched->closed

MFC'd to stable/8 and stable/7.  Thanks!