History

Documentation: input: joydev file corrections

Fix typos, grammar, punctuation in Documentation/input/joydev/*.rst files.

Randy Dunlap committed 5 years ago

Commit eef8abd1 parent 6a791622 files · +20 −20Browse files

Showing the changes to Documentation/input (2 of 2 files). Show all

Unified · Split

2 files
  1. Documentation/input/joydev/joystick-api.rst +7 −7
  2. Documentation/input/joydev/joystick.rst +13 −13
Documentation/input/joydev/joystick-api.rst+7−7
@@ -71,7 +71,7 @@ The possible values of ``type`` are:: · 70 unmodified lines
7171 #define JS_EVENT_INIT 0x80 /* initial state of device */
7272
7373 As mentioned above, the driver will issue synthetic JS_EVENT_INIT ORed
74−events on open. That is, if it's issuing a INIT BUTTON event, the
74+events on open. That is, if it's issuing an INIT BUTTON event, the
7575 current type value will be::
7676
7777 int type = JS_EVENT_BUTTON | JS_EVENT_INIT; /* 0x81 */
@@ -100,8 +100,8 @@ is, you have both an axis 0 and a button 0). Generally, · 22 unmodified lines
100100 =============== =======
101101
102102 Hats vary from one joystick type to another. Some can be moved in 8
103−directions, some only in 4, The driver, however, always reports a hat as two
104−independent axis, even if the hardware doesn't allow independent movement.
103+directions, some only in 4. The driver, however, always reports a hat as two
104+independent axes, even if the hardware doesn't allow independent movement.
105105
106106
107107 js_event.value
@@ -188,10 +188,10 @@ One reason for emptying the queue is that if it gets full you'll start · 80 unmodified lines
188188 missing events since the queue is finite, and older events will get
189189 overwritten.
190190
191−The other reason is that you want to know all what happened, and not
191+The other reason is that you want to know all that happened, and not
192192 delay the processing till later.
193193
194−Why can get the queue full? Because you don't empty the queue as
194+Why can the queue get full? Because you don't empty the queue as
195195 mentioned, or because too much time elapses from one read to another
196196 and too many events to store in the queue get generated. Note that
197197 high system load may contribute to space those reads even more.
@@ -277,7 +277,7 @@ to be in the stable part of the API, and therefore may change without · 79 unmodified lines
277277 warning in following releases of the driver.
278278
279279 Both JSIOCSCORR and JSIOCGCORR expect &js_corr to be able to hold
280−information for all axis. That is, struct js_corr corr[MAX_AXIS];
280+information for all axes. That is, struct js_corr corr[MAX_AXIS];
281281
282282 struct js_corr is defined as::
283283
@@ -328,7 +328,7 @@ To test the state of the buttons, · 44 unmodified lines
328328 second_button_state = js.buttons & 2;
329329
330330 The axis values do not have a defined range in the original 0.x driver,
331−except for that the values are non-negative. The 1.2.8+ drivers use a
331+except that the values are non-negative. The 1.2.8+ drivers use a
332332 fixed range for reporting the values, 1 being the minimum, 128 the
333333 center, and 255 maximum value.
334334
Documentation/input/joydev/joystick.rst+13−13
@@ -133,15 +133,15 @@ And add a line to your rc script executing that file:: · 132 unmodified lines
133133 This way, after the next reboot your joystick will remain calibrated. You
134134 can also add the ``jscal -p`` line to your shutdown script.
135135
136−HW specific driver information
137−==============================
136+Hardware-specific driver information
137+====================================
138138
139139 In this section each of the separate hardware specific drivers is described.
140140
141141 Analog joysticks
142142 ----------------
143143
144−The analog.c uses the standard analog inputs of the gameport, and thus
144+The analog.c driver uses the standard analog inputs of the gameport, and thus
145145 supports all standard joysticks and gamepads. It uses a very advanced
146146 routine for this, allowing for data precision that can't be found on any
147147 other system.
@@ -266,7 +266,7 @@ to: · 118 unmodified lines
266266 * Logitech WingMan Extreme Digital 3D
267267
268268 ADI devices are autodetected, and the driver supports up to two (any
269−combination of) devices on a single gameport, using an Y-cable or chained
269+combination of) devices on a single gameport, using a Y-cable or chained
270270 together.
271271
272272 Logitech WingMan Joystick, Logitech WingMan Attack, Logitech WingMan
@@ -288,7 +288,7 @@ supports: · 15 unmodified lines
288288 * Gravis Xterminator DualControl
289289
290290 All these devices are autodetected, and you can even use any combination
291−of up to two of these pads either chained together or using an Y-cable on a
291+of up to two of these pads either chained together or using a Y-cable on a
292292 single gameport.
293293
294294 GrIP MultiPort isn't supported yet. Gravis Stinger is a serial device and is
@@ -311,7 +311,7 @@ allow connecting analog joysticks to them, you'll need to load the analog · 16 unmodified lines
311311 driver as well to handle the attached joysticks.
312312
313313 The trackball should work with USB mousedev module as a normal mouse. See
314−the USB documentation for how to setup an USB mouse.
314+the USB documentation for how to setup a USB mouse.
315315
316316 ThrustMaster DirectConnect (BSP)
317317 --------------------------------
@@ -332,7 +332,7 @@ If you have one of these, contact me. · 14 unmodified lines
332332
333333 TMDC devices are autodetected, and thus no parameters to the module
334334 are needed. Up to two TMDC devices can be connected to one gameport, using
335−an Y-cable.
335+a Y-cable.
336336
337337 Creative Labs Blaster
338338 ---------------------
@@ -342,7 +342,7 @@ the: · 3 unmodified lines
342342
343343 * Creative Blaster GamePad Cobra
344344
345−Up to two of these can be used on a single gameport, using an Y-cable.
345+Up to two of these can be used on a single gameport, using a Y-cable.
346346
347347 Genius Digital joysticks
348348 ------------------------
@@ -381,7 +381,7 @@ card, 16 in case you have two in your system. · 32 unmodified lines
381381 Trident 4DWave / Aureal Vortex
382382 ------------------------------
383383
384−Soundcards with a Trident 4DWave DX/NX or Aureal Vortex/Vortex2 chipsets
384+Soundcards with a Trident 4DWave DX/NX or Aureal Vortex/Vortex2 chipset
385385 provide an "Enhanced Game Port" mode where the soundcard handles polling the
386386 joystick. This mode is supported by the pcigame.c module. Once loaded the
387387 analog driver can use the enhanced features of these gameports..
@@ -454,7 +454,7 @@ Devices currently supported by spaceball.c are: · 66 unmodified lines
454454 * SpaceTec SpaceBall 4000 FLX
455455
456456 In addition to having the spaceorb/spaceball and serport modules in the
457−kernel, you also need to attach a serial port to it. to do that, run the
457+kernel, you also need to attach a serial port to it. To do that, run the
458458 inputattach program::
459459
460460 inputattach --spaceorb /dev/tts/x &
@@ -466,7 +466,7 @@ or:: · 5 unmodified lines
466466 where /dev/tts/x is the serial port which the device is connected to. After
467467 doing this, the device will be reported and will start working.
468468
469−There is one caveat with the SpaceOrb. The button #6, the on the bottom
469+There is one caveat with the SpaceOrb. The button #6, the one on the bottom
470470 side of the orb, although reported as an ordinary button, causes internal
471471 recentering of the spaceorb, moving the zero point to the position in which
472472 the ball is at the moment of pressing the button. So, think first before
@@ -500,7 +500,7 @@ joy-magellan module. It currently supports only the: · 27 unmodified lines
500500 * Magellan 3D
501501 * Space Mouse
502502
503−models, the additional buttons on the 'Plus' versions are not supported yet.
503+models; the additional buttons on the 'Plus' versions are not supported yet.
504504
505505 To use it, you need to attach the serial port to the driver using the::
506506
@@ -575,7 +575,7 @@ FAQ · 68 unmodified lines
575575 :A: The device files don't exist. Create them (see section 2.2).
576576
577577 :Q: Is it possible to connect my old Atari/Commodore/Amiga/console joystick
578− or pad that uses a 9-pin D-type cannon connector to the serial port of my
578+ or pad that uses a 9-pin D-type Cannon connector to the serial port of my
579579 PC?
580580 :A: Yes, it is possible, but it'll burn your serial port or the pad. It
581581 won't work, of course.