Commit Graph

50 Commits

Author SHA1 Message Date
Laurent Pinchart
9cad9c95d7 Documentation: DocBook DRM framework documentation
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Rob Clark <rob.clark@linaro.org>
2012-08-23 12:02:53 +02:00
Michael Witten
bcd3cfc121 DocBook/drm: Clean up a todo-note
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:37 +00:00
Michael Witten
7f0925aca5 DocBook/drm: device aware' -> device-aware'
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:35 +00:00
Michael Witten
a5294e01f2 DocBook/drm: (device|driver) specific' -> (device|driver)-specific'
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:33 +00:00
Michael Witten
5a462d58c8 DocBook/drm: Clean up the paragraph on framebuffer objects
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:32 +00:00
Michael Witten
964d32dcbe DocBook/drm: Use `; otherwise,'
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:30 +00:00
Michael Witten
e355b2014d DocBook/drm: Better flow with `, and then'
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:28 +00:00
Michael Witten
b8c6e0fe46 DocBook/drm: Refer to the domain-setting function as a device-specific ioctl
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:26 +00:00
Michael Witten
2d43f5d667 DocBook/drm: Improve flow of GPU/CPU coherence sentence
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:24 +00:00
Michael Witten
0c2d91a80a DocBook/drm: Use an <itemizelist> for fundamental GEM operations
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:22 +00:00
Michael Witten
f877bd4ad5 DocBook/drm: Insert a comma
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:20 +00:00
Michael Witten
51b9500de2 DocBook/drm: Use a <variablelist> for vblank ioctls
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:18 +00:00
Michael Witten
65ffef508f DocBook/drm: Use an itemizedlist for what an encoder needs to provide
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:16 +00:00
Michael Witten
4dc0152d57 DocBook/drm: Insert the' for readability, and change set' to `setting'
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:14 +00:00
Michael Witten
896ee65fb6 DocBook/drm: Remove extraneous commas
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:12 +00:00
Michael Witten
8a9ba910ac DocBook/drm: Use a colon
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:09 +00:00
Michael Witten
327d6fb962 DocBook/drm: Clarify `final initialization' via better formatting
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:07 +00:00
Michael Witten
3bf7df6156 DocBook/drm: Remove redundancy
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:05 +00:00
Michael Witten
1dbd39c3ea DocBook/drm: Insert `it' for smooth reading
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:03 +00:00
Michael Witten
9029bd7a42 DocBook/drm: The word `so-called'; I do not think it connotes what you think it connotes
From Webster's Revised Unabridged Dictionary (1913) [web1913]:

    So-called \So"-called`\, a.
       So named; called by such a name (but perhaps called thus with
       doubtful propriety).

  From WordNet (r) 2.0 [wn]:

    so-called
         adj : doubtful or suspect; "these so-called experts are no help"
               [syn: {alleged(a)}, {supposed}]

My strong conviction is that widespread use of 'so gennant'
or 'sogennant' in German has led to the creeping misuse of
'so-called' in English (especially through technical writings).

In English, it would be better to use:

  what is called

or a better translation of 'so gennant':

  so named

Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 20:00:01 +00:00
Michael Witten
54f2cb8fc9 DocBook/drm: Use a singular subject for grammatical cleanliness
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:59:59 +00:00
Michael Witten
482b2ad8e4 DocBook/drm: basic -> core
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:59:56 +00:00
Michael Witten
049cc903e7 DocBook/drm: Streamline wording of GEM initialization
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:59:54 +00:00
Michael Witten
ae63d793a4 DocBook/drm: Insert `()' after function name
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:59:52 +00:00
Michael Witten
1c86de2216 DocBook/drm: Remove parentheses and unnecessary repetition
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:59:50 +00:00
Michael Witten
005d7f4a01 DocBook/drm: Insert missing comma
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:59:48 +00:00
Michael Witten
eb2b8d4273 DocBook/drm: , -> :
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:59:45 +00:00
Michael Witten
8d36ffae67 DocBook/drm: can -> could
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:31:10 +00:00
Michael Witten
118bdd70bd DocBook/drm: Offset modifiers with commas
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:31:08 +00:00
Michael Witten
9c2416adac DocBook/drm: Use the passive voice
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:31:06 +00:00
Michael Witten
bb49a6a1f3 DocBook/drm: at driver load time' -> when the driver is loaded'
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:31:03 +00:00
Michael Witten
5b658bf2bf DocBook/drm: setup' is the noun; to set up' is the verb
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:59 +00:00
Michael Witten
f07faf693c DocBook/drm: Insert missing `an'
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:56 +00:00
Michael Witten
8814630f0b DocBook/drm: Insert missing `that'
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:53 +00:00
Michael Witten
57a15fd663 DocBook/drm: Clearer wording with `for consumption by'
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:50 +00:00
Michael Witten
06fa7b8066 DocBook/drm: Better wording
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:47 +00:00
Michael Witten
6e375f44b6 DocBook/drm: Replace the paragraph's first sentence with its last sentence
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:45 +00:00
Michael Witten
75aa9df5a2 DocBook/drm: Rearrange wording to make more sense
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:42 +00:00
Michael Witten
58f1d652de DocBook/drm: Clean up `pre-memory management aware'
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:39 +00:00
Michael Witten
80c84e6f3c DocBook/drm: Move `should be set' to the beginning of the sentence
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:37 +00:00
Michael Witten
b1f95bdc1e DocBook/drm: , -> .
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:34 +00:00
Michael Witten
02391f1fe7 DocBook/drm: a -> an
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:32 +00:00
Michael Witten
2c267e9e01 DocBook/drm: Use a semicolon
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:29 +00:00
Michael Witten
0c54781bc5 DocBook/drm: Clean up code comment
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-29 19:30:24 +00:00
Michael Witten
f11aca045c DocBook/drm: can -> may
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-25 21:29:55 +00:00
Michael Witten
a78f6787a3 DocBook/drm: Eradicate inappropriate uses of the future tense
Signed-off-by: Michael Witten <mfwitten@gmail.com>
2011-08-25 17:18:08 +00:00
Xiao Jiang
bd91572e77 drm: fix wrong usages of drm_device in DRM Developer's Guide
A few wrong usages of drm_device, which should be drm_driver.

Signed-off-by: Xiao Jiang <jgq516@gmail.com>
Signed-off-by: Dave Airlie <airlied@redhat.com>
2011-02-15 09:01:29 +10:00
Arnd Bergmann
dc880abef7 drm: use noop_llseek
The drm device drivers currently allow seeking on the
character device but never care about the actual
file position.

When we change the default llseek operation to be
no_llseek, calling llseek on a drm device would
return an error condition, which is an API change.

Explicitly setting noop_llseek lets us keep the
current API.

Signed-off-by: Arnd Bergmann <arnd@arndb.de>
Cc: David Airlie <airlied@linux.ie>
Cc: dri-devel@lists.freedesktop.org
2010-09-16 10:33:07 +02:00
Nicolas Kaiser
ce04cc089b drm: fix typos in Linux DRM Developer's Guide
A few typos in the DRM Developer's Guide.

Signed-off-by: Nicolas Kaiser <nikai@nikai.net>
Acked-by: Jesse Barnes <jesse.barnes@intel.com>
Signed-off-by: Dave Airlie <airlied@redhat.com>
2010-06-03 13:13:32 +10:00
Jesse Barnes
2d2ef82275 drm: add initial DRM developer documentation
Add a DRM DocBook providing basic information about DRM interfaces, including
TTM, GEM, KMS and vblank infrastructure.  Intended to provide information to
new and existing developers about how to perform driver initialization,
implement mode setting and other DRM features.

Signed-off-by: Jesse Barnes <jbarnes@virtuousgeek.org>
Signed-off-by: Dave Airlie <airlied@redhat.com>
2010-04-21 08:12:11 +10:00