Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 101912 - xorg-config typo corrections and suggestions for clarity
Summary: xorg-config typo corrections and suggestions for clarity
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs-user
Classification: Unclassified
Component: Other (show other bugs)
Hardware: All All
: High trivial (vote)
Assignee: Shyam Mani (RETIRED)
URL: http://www.gentoo.org/doc/en/xorg-con...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-08-09 15:51 UTC by Erik Musick
Modified: 2005-09-09 13:14 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Erik Musick 2005-08-09 15:51:28 UTC
"Text snippet of concern" followed by quick fix or "quoted suggestion."


"and other basic yet important aspects has" "and other basic, yet important
aspects, has"

"freely redistributable open-source" "freely redistributable, open-source" Added
comma. Maybe a personal thing, but I think hyphenation can add clarity even if
it is no necessarily proper (re-distributable and re-initialise, mentioned above
COde Listing 2.2)

"xorgcfg, which will first attempts" attempt (drop the 's')

First a double hyphen ("-config -- typing") is used to denote a following
comment, however later on ("disgracefully - something") only a single is used.
Mentioned to add consistency.

Depending how many hyphens are decided on, "strings - they" may need to be changed

In Code Listing 4.1, perhaps alining the option parameters would aid in readability.

"Just substitute the country-keycode with yours:" Perhaps offer a link to
international codes

"your mouse by checking the output" Sounds like the output /should/ be
meaningful when, in fact, it is not.

"If your mouse isn't detected, verify if all the necessary modules are loaded."
Examples of modules to look for and how?

"If your mouse is detected, fill in the device" How do you find out the device name?

Depending how many hyphens are decided on, "used - most" may need to be changed

In Code Listing 4.4, perhaps alining the option parameters would aid in readability.

"syntaxis" looks as if it should be "syntaxes" (be sure to change both instances)

Reproducible: Always
Steps to Reproduce:
1.
2.
3.
Comment 1 Shyam Mani (RETIRED) gentoo-dev 2005-09-08 23:02:25 UTC
(In reply to comment #0)
> In Code Listing 4.1, perhaps alining the option parameters would aid in
readability.

Already are aligned, check your browser/fonts.
 
> "your mouse by checking the output" Sounds like the output /should/ be
> meaningful when, in fact, it is not.

Fixed.
 
> In Code Listing 4.4, perhaps alining the option parameters would aid in
readability.

Same as 4.1
 
> "syntaxis" looks as if it should be "syntaxes" (be sure to change both instances)

Check the dictionary :)

"The Collaborative International Dictionary of English v.0.48"
Syntaxis Syn*tax"is, n.
   Syntax. R. --B. Jonson.
   1913 Webster

Rest of the stuff, fixed as needed and changes are in CVS. Thanks!
Comment 2 Erik Musick 2005-09-09 07:35:05 UTC
Odd, I found more instances of "syntaxes," but found plenty of both.

Anyway, about the alignment in the code sections, I was a bit unclear or my
fonts are scary bad. I intended to draw attention to, for example 'SubSection
"Display"' and 'Depth   24'. The SubSection and Depth are fine, but Display and
24 are off by 2 spaces. Really, it's nothing big, just thought having all the
values lined up might enhance readability. Thanks for reviewing this.
Comment 3 Shyam Mani (RETIRED) gentoo-dev 2005-09-09 11:16:55 UTC
(In reply to comment #2)

> "Display"' and 'Depth   24'. The SubSection and Depth are fine, but Display and
> 24 are off by 2 spaces. Really, it's nothing big, just thought having all the
> values lined up might enhance readability. Thanks for reviewing this.

Nah, that's quite intentional and the indentation makes it more readable actually :)
Comment 4 Erik Musick 2005-09-09 11:55:05 UTC
Hehe. I'm honestly not trying to be annoying, but checking so I don't do this on
other bugs :P

This:
Identifier  "Generic Keyboard"
Driver    "keyboard"
Option    "CoreKeyboard"

Versus:
Identifier  "Generic Keyboard"
Driver      "keyboard"
Option      "CoreKeyboard"
Comment 5 Shyam Mani (RETIRED) gentoo-dev 2005-09-09 13:14:41 UTC
From my /etc/X11/xorg.conf,

Identifier  "Mouse1"
Driver      "mouse"
Option "Protocol"    "IMPS/2"
Option "Device"      "/dev/psaux"
Option "ZAxisMapping" "4 5"

So I guess the code listing is accurate.