Bug 162154

Summary: [handbook] section 6.4.2 misordering.
Product: Documentation Reporter: r. clayton <rclayton>
Component: Books & ArticlesAssignee: Manolis Kiagias <manolis>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description r. clayton 2011-10-29 17:50:01 UTC
The two paragraphs

  As of version 7.3, Xorg can often work without any configuration file by
  simply typing at prompt:

    % startx

  Starting with version 7.4, Xorg can use HAL to autodetect keyboards and
  mice. The sysutils/hal and devel/dbus ports are installed as dependencies of
  x11/xorg, but must be enabled by the following entries in the /etc/rc.conf
  file:

    hald_enable="YES"
    dbus_enable="YES"

  These services should be started (either manually or by rebooting) before
  further Xorg configuration is attempted.

in section 6.4.2 of 

  http://www.freebsd.org/doc/handbook/x-config.html

are in reverse order.  My experience has been running startx without enabling hald and dbus leaves me without a mouse or keyboard.

Fix: 

It might be more accurate and helpful to flip the two paragraphs, something like

  Starting with version 7.4, Xorg can use HAL to autodetect keyboards and
  mice. The sysutils/hal and devel/dbus ports are installed as dependencies of
  x11/xorg, but must be enabled by the following entries in the /etc/rc.conf
  file:

    hald_enable="YES"
    dbus_enable="YES"

  These services should be started (either manually or by rebooting) before
  further Xorg configuration is attempted.

  As of version 7.3, Xorg can often work without any configuration file by
  simply typing at prompt:

    % startx

with suitable adjustments to the sentence starting "These services..." to
indicate that not only should these services be enabled before configuration,
but before using X11 at all.
How-To-Repeat: Install xorg from ports, stop reading section 6.4 after the startx part, run startx.
Comment 1 sonic2000gr 2011-10-29 18:36:18 UTC
On 29/10/2011 7:41 ìì, r. clayton wrote:
>
> Description:
> The two paragraphs
>
>    As of version 7.3, Xorg can often work without any configuration file by
>    simply typing at prompt:
>
>      % startx
>
>    Starting with version 7.4, Xorg can use HAL to autodetect keyboards and
>    mice. The sysutils/hal and devel/dbus ports are installed as dependencies of
>    x11/xorg, but must be enabled by the following entries in the /etc/rc.conf
>    file:
>
>      hald_enable="YES"
>      dbus_enable="YES"
>
>    These services should be started (either manually or by rebooting) before
>    further Xorg configuration is attempted.
>
> in section 6.4.2 of
>
>    http://www.freebsd.org/doc/handbook/x-config.html
>
> are in reverse order.  My experience has been running startx without enabling hald and dbus leaves me without a mouse or keyboard.
>> How-To-Repeat:
> Install xorg from ports, stop reading section 6.4 after the startx part, run startx.

Heh, not a good idea to stop reading at the middle of the section :)
But I totally agree with you about the ordering of the paragraphs.

>> Fix:
> It might be more accurate and helpful to flip the two paragraphs, something like
>
>    Starting with version 7.4, Xorg can use HAL to autodetect keyboards and
>    mice. The sysutils/hal and devel/dbus ports are installed as dependencies of
>    x11/xorg, but must be enabled by the following entries in the /etc/rc.conf
>    file:
>
>      hald_enable="YES"
>      dbus_enable="YES"
>
>    These services should be started (either manually or by rebooting) before
>    further Xorg configuration is attempted.
>
>    As of version 7.3, Xorg can often work without any configuration file by
>    simply typing at prompt:
>
>      % startx
>
> with suitable adjustments to the sentence starting "These services..." to
> indicate that not only should these services be enabled before configuration,
> but before using X11 at all.
>

In fact, I think we can completely remove the version information at 
this point. We've had 7.5 in the ports for some time now, I doubt anyone 
would install 7.2 now - the reference only serves historical purposes. I 
would suggest something like the following:

"Xorg  uses HAL to autodetect keyboards and mice. The sysutils/hal and 
devel/dbus ports are installed as dependencies of x11/xorg, but must be 
enabled by the following entries in the /etc/rc.conf file:

hald_enable="YES"
dbus_enable="YES"
These services should be started (either manually or by rebooting) 
before further Xorg configuration or use is attempted.

Xorg can often work without any further configuration steps, by simply 
typing at prompt:

% startx

The automatic configuration may fail to work with some hardware, or may 
not set things up quite as desired. In these cases, manual configuration 
will be necessary...."
Comment 2 sonic2000gr 2011-10-29 19:09:53 UTC
Here is a complete patch, also with version information removed:

http://www.freebsdgr.org/all/en_US.ISO8859-1/books/handbook/x11/x11.patch

And a test build here:

http://www.freebsdgr.org/all/en_US.ISO8859-1/books/handbook/x-config.html

This clears up the chapter a bit, I doubt we need to reference 7.3 and 
earlier versions specifically anymore. Any objections?
Comment 3 Manolis Kiagias freebsd_committer freebsd_triage 2011-10-29 19:11:44 UTC
Responsible Changed
From-To: freebsd-doc->manolis

I'll handle this one
Comment 4 Glen Barber freebsd_committer freebsd_triage 2011-10-29 21:53:10 UTC
Hi Manolis,

On 10/29/11 2:09 PM, Manolis Kiagias wrote:
> Here is a complete patch, also with version information removed:
> 
> http://www.freebsdgr.org/all/en_US.ISO8859-1/books/handbook/x11/x11.patch
> 
> And a test build here:
> 
> http://www.freebsdgr.org/all/en_US.ISO8859-1/books/handbook/x-config.html
> 
> This clears up the chapter a bit, I doubt we need to reference 7.3 and
> earlier versions specifically anymore. Any objections?


I think it looks good.  I say go for it. :-)

-- 
Glen Barber | gjb@FreeBSD.org
FreeBSD Documentation Project
Comment 5 r. clayton 2011-10-30 12:54:21 UTC
  Here is a complete patch, also with version information removed:

Thanks for the quick, and positive, response.  I've run across a few other
places in the handbook with reversed ordering; I've written them down
somewhere, but don't remember where.  I'll try to find them, and submit them if
they're still relevant.
Comment 6 sonic2000gr 2011-10-30 13:04:59 UTC
On 30/10/2011 2:54 ìì, R. Clayton wrote:
>    Here is a complete patch, also with version information removed:
>
> Thanks for the quick, and positive, response.  I've run across a few other
> places in the handbook with reversed ordering; I've written them down
> somewhere, but don't remember where.  I'll try to find them, and submit them if
> they're still relevant.
>

Thanks for submitting this. The patch will probably be committed later 
on today.
If you do find your notes, we'll be glad to hear from you again.

Thanks for helping improve FreeBSD!
Comment 7 dfilter service freebsd_committer freebsd_triage 2011-10-30 17:29:23 UTC
manolis     2011-10-30 17:29:14 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/handbook/x11 chapter.sgml 
  Log:
  Clean up the section on Configuring X11:
  
  - Reorder the first two paragraphs [1]
  - Retire information concerning no longer relevant Xorg versions
  
  PR:             docs/162154 [1]
  Reported by:    R. Clayton <rclayton at monmouth dot edu>
  Reviewed by:    gjb
  
  Revision  Changes    Path
  1.208     +19 -27    doc/en_US.ISO8859-1/books/handbook/x11/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 8 Manolis Kiagias freebsd_committer freebsd_triage 2011-10-30 17:37:05 UTC
State Changed
From-To: open->closed

Changes were committed, and will appear on the website soon. 
Thanks for the report!