From mboxrd@z Thu Jan 1 00:00:00 1970 From: Dave Gordon Subject: Re: [PATCH] drm: Documentation style guide Date: Tue, 15 Dec 2015 14:56:10 +0000 Message-ID: <56702A0A.5060900@intel.com> References: <20151209151942.GA29631@wunner.de> <1449677282-30832-1-git-send-email-daniel.vetter@ffwll.ch> <20151214153906.GB1998@ulmo> Mime-Version: 1.0 Content-Type: text/plain; charset="utf-8"; Format="flowed" Content-Transfer-Encoding: base64 Return-path: In-Reply-To: <20151214153906.GB1998@ulmo> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" To: Thierry Reding , Daniel Vetter Cc: Daniel Vetter , Intel Graphics Development , Laurent Pinchart , DRI Development List-Id: intel-gfx@lists.freedesktop.org T24gMTQvMTIvMTUgMTU6MzksIFRoaWVycnkgUmVkaW5nIHdyb3RlOgo+IE9uIFdlZCwgRGVjIDA5 LCAyMDE1IGF0IDA1OjA4OjAyUE0gKzAxMDAsIERhbmllbCBWZXR0ZXIgd3JvdGU6Cj4+IEV2ZXJ5 IHRpbWUgSSB0eXBlIG9yIHJldmlldyBkb2NzIHRoaXMgc2VlbXMgYSBiaXQgZGlmZmVyZW50LiBU cnkgdG8KPj4gZG9jdW1lbnQgdGhlIGNvbW1vbiBzdHlsZSBzbyB3ZSBjYW4gdHJ5IHRvIHVuaWZ5 IGF0IGxlYXN0IG5ldyBkb2NzLgo+Pgo+PiB2MjogU3BlbGxpbmcgZml4ZXMgZnJvbSBQaWVycmUs IExhdXJlbnQgYW5kIEphbmkuCj4+Cj4+IHYzOiBNb3JlIHNwZWxsaW5nIGZpeGVzIGZyb20gTHVr YXMuCj4+Cj4+IENjOiBQaWVycmUgTW9yZWF1IDxwaWVycmUubW9ycm93QGZyZWUuZnI+Cj4+IENj OiBKYW5pIE5pa3VsYSA8amFuaS5uaWt1bGFAbGludXguaW50ZWwuY29tPgo+PiBDYzogTGF1cmVu dCBQaW5jaGFydCA8bGF1cmVudC5waW5jaGFydEBpZGVhc29uYm9hcmQuY29tPgo+PiBDYzogTHVr YXMgV3VubmVyIDxsdWthc0B3dW5uZXIuZGU+Cj4+IEFja2VkLWJ5OiBMYXVyZW50IFBpbmNoYXJ0 IDxsYXVyZW50LnBpbmNoYXJ0QGlkZWFzb25ib2FyZC5jb20+Cj4+IFNpZ25lZC1vZmYtYnk6IERh bmllbCBWZXR0ZXIgPGRhbmllbC52ZXR0ZXJAaW50ZWwuY29tPgo+PiBMaW5rOiBodHRwOi8vcGF0 Y2h3b3JrLmZyZWVkZXNrdG9wLm9yZy9wYXRjaC9tc2dpZC8xNDQ5NTY0NTYxLTM4OTYtMS1naXQt c2VuZC1lbWFpbC1kYW5pZWwudmV0dGVyQGZmd2xsLmNoCj4+IC0tLQo+PiAgIERvY3VtZW50YXRp b24vRG9jQm9vay9ncHUudG1wbCB8IDM3ICsrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysr KysrKysKPj4gICAxIGZpbGUgY2hhbmdlZCwgMzcgaW5zZXJ0aW9ucygrKQo+Pgo+PiBkaWZmIC0t Z2l0IGEvRG9jdW1lbnRhdGlvbi9Eb2NCb29rL2dwdS50bXBsIGIvRG9jdW1lbnRhdGlvbi9Eb2NC b29rL2dwdS50bXBsCj4+IGluZGV4IDc0OWI4ZTJmMjExMy4uYzY2ZDY0MTJmNTczIDEwMDY0NAo+ PiAtLS0gYS9Eb2N1bWVudGF0aW9uL0RvY0Jvb2svZ3B1LnRtcGwKPj4gKysrIGIvRG9jdW1lbnRh dGlvbi9Eb2NCb29rL2dwdS50bXBsCj4+IEBAIC0xMjQsNiArMTI0LDQzIEBACj4+ICAgICAgIDxw YXJhPgo+PiAgICAgICAgIFtJbnNlcnQgZGlhZ3JhbSBvZiB0eXBpY2FsIERSTSBzdGFjayBoZXJl XQo+PiAgICAgICA8L3BhcmE+Cj4+ICsgIDxzZWN0MT4KPj4gKyAgICA8dGl0bGU+U3R5bGUgR3Vp ZGVsaW5lczwvdGl0bGU+Cj4+ICsgICAgPHBhcmE+Cj4+ICsgICAgICBGb3IgY29uc2lzdGVuY3kg dGhpcyBkb2N1bWVudGF0aW9uIHVzZXMgQW1lcmljYW4gRW5nbGlzaC4gQWJicmV2aWF0aW9ucwo+ PiArICAgICAgYXJlIHdyaXR0ZW4gYXMgYWxsLXVwcGVyY2FzZSwgZm9yIGV4YW1wbGU6IERSTSwg S01TLCBJT0NUTCwgQ1JUQywgYW5kIHNvCj4+ICsgICAgICBvbi4gVG8gYWlkIGluIHJlYWRpbmcs IGRvY3VtZW50YXRpb25zIG1ha2UgZnVsbCB1c2Ugb2YgdGhlIG1hcmt1cAo+Cj4gIi4uLiwgdGhl IGRvY3VtZW50YXRpb24gbWFrZXMgZnVsbCB1c2Ugb2YuLi4iIGFuZCBwZXJoYXBzICJtYWtlcyB1 c2Ugb2YKPiB0aGUgZnVsbCBzZXQgb2YgbWFya3VwIGNoYXJhY3RlcnMgdGhhdCBrZXJuZWxkb2Mg cHJvdmlkZXMiLgo+Cj4+ICsgICAgICBjaGFyYWN0ZXJzIGtlcm5lbGRvYyBwcm92aWRlczogQHBh cmFtZXRlciBmb3IgZnVuY3Rpb24gcGFyYW1ldGVycywgQG1lbWJlcgo+PiArICAgICAgZm9yIHN0 cnVjdHVyZSBtZW1iZXJzLCAmYW1wO3N0cnVjdHVyZSB0byByZWZlcmVuY2Ugc3RydWN0dXJlcyBh bmQKPj4gKyAgICAgIGZ1bmN0aW9uKCkgZm9yIGZ1bmN0aW9ucy4gVGhlc2UgYWxsIGdldCBhdXRv bWF0aWNhbGx5IGh5cGVybGlua2VkIGlmCj4+ICsgICAgICBrZXJuZWxkb2MgZm9yIHRoZSByZWZl cmVuY2VkIG9iamVjdHMgZXhpc3RzLiBXaGVuIHJlZmVyZW5jaW5nIGVudHJpZXMgaW4KPj4gKyAg ICAgIGZ1bmN0aW9uIHZ0YWJsZXMgcGxlYXNlIHVzZSAtJmd0O3ZmdW5jKCkuIE5vdGUgdGhhdCBr ZXJuZWxkb2MgZG9lcwo+PiArICAgICAgbm90IHN1cHBvcnQgcmVmZXJlbmNpbmcgc3RydWN0IG1l bWJlcnMgZGlyZWN0bHksIHNvIHBsZWFzZSBhZGQgYSByZWZlcmVuY2UKPj4gKyAgICAgIHRvIHRo ZSB2dGFibGUgc3RydWN0IHNvbWV3aGVyZSBpbiB0aGUgc2FtZSBwYXJhZ3JhcGggb3IgYXQgbGVh c3Qgc2VjdGlvbi4KPj4gKyAgICA8L3BhcmE+Cj4+ICsgICAgPHBhcmE+Cj4+ICsgICAgICBFeGNl cHQgaW4gc3BlY2lhbCBzaXR1YXRpb25zICh0byBzZXBhcmF0ZSBsb2NrZWQgZnJvbSB1bmxvY2tl ZCB2YXJpYW50cykKPj4gKyAgICAgIGxvY2tpbmcgcmVxdWlyZW1lbnRzIGZvciBmdW5jdGlvbnMg YXJlbid0IGRvY3VtZW50ZWQgaW4gdGhlIGtlcm5lbGRvYy4KPj4gKyAgICAgIEluc3RlYWQgbG9j a2luZyBzaG91bGQgYmUgY2hlY2sgYXQgcnVudGltZSB1c2luZyBlLmcuCj4KPiAic2hvdWxkIGJl IGNoZWNrZWQiCj4KPj4gKyAgICAgIDxjb2RlPldBUk5fT04oIW11dGV4X2lzX2xvY2tlZCguLi4p KTs8L2NvZGU+LiBTaW5jZSBpdCdzIG11Y2ggZWFzaWVyIHRvCj4+ICsgICAgICBpZ25vcmUgZG9j dW1lbnRhdGlvbiB0aGFuIHJ1bnRpbWUgbm9pc2UgdGhpcyBwcm92aWRlcyBtb3JlIHZhbHVlLiBB bmQgb24KPj4gKyAgICAgIHRvcCBvZiB0aGF0IHJ1bnRpbWUgY2hlY2tzIGRvIG5lZWQgdG8gYmUg dXBkYXRlZCB3aGVuIHRoZSBsb2NraW5nIHJ1bGVzCj4+ICsgICAgICBjaGFuZ2UsIGluY3JlYXNp bmcgdGhlIGNoYW5jZXMgdGhhdCB0aGV5J3JlIGNvcnJlY3QuIFdpdGhpbiB0aGUKCkEgZmV3IGNv bW1hcyB0byBkZWxpbWl0IHN1YmNsYXVzZXMgd291bGQgbWFrZSB0aGlzIG1vcmUgcmVhZGFibGU6 CgpTaW5jZSBpdCdzIG11Y2ggZWFzaWVyIHRvIGlnbm9yZSBkb2N1bWVudGF0aW9uIHRoYW4gcnVu dGltZSBub2lzZSwgdGhpcyAKcHJvdmlkZXMgbW9yZSB2YWx1ZS4gQW5kIG9uIHRvcCBvZiB0aGF0 LCBydW50aW1lIGNoZWNrcyBoYXZlIHRvIGJlIAp1cGRhdGVkIHdoZW4gdGhlIGxvY2tpbmcgcnVs ZXMgY2hhbmdlLCB0aHVzIGluY3JlYXNpbmcgdGhlIGNoYW5jZXMgdGhhdCAKdGhleSdyZSBjb3Jy ZWN0LgoKPj4gKyAgICAgIGRvY3VtZW50YXRpb24gdGhlIGxvY2tpbmcgcnVsZXMgc2hvdWxkIGJl IGV4cGxhaW5lZCBpbiB0aGUgcmVsZXZhbnQKPj4gKyAgICAgIHN0cnVjdHVyZXM6IEVpdGhlciBp biB0aGUgY29tbWVudCBmb3IgdGhlIGxvY2sgZXhwbGFpbmluZyB3aGF0IGl0Cj4+ICsgICAgICBw cm90ZWN0cywgb3IgZGF0YSBmaWVsZHMgbmVlZCBhIG5vdGUgYWJvdXQgd2hpY2ggbG9jayBwcm90 ZWN0cyB0aGVtLCBvcgo+PiArICAgICAgYm90aC4KPgo+IEkgdGhpbmsgeW91J3JlIHN1cHBvc2Vk IHRvIGhhdmUgdGhlICJvciIgb25seSBpbiB0aGUgZmluYWwgc3Vic2VudGVuY2U6Cj4KPiAJImVp dGhlciAuLi4gcHJvdGVjdHMsIGRhdGEgZmllbGRzIG5lZWQgLi4uLCBvciBib3RoLiIKCldpdGhp biB0aGUgZG9jdW1lbnRhdGlvbiwgdGhlIGxvY2tpbmcgcnVsZXMgc2hvdWxkIGJlIGV4cGxhaW5l ZCBpbiAKY29tbWVudHMgb24gdGhlIHJlbGV2YW50IHN0cnVjdHVyZXM7IHRoZXNlIGNvbW1lbnRz IG1heSBiZSB3aXRoIHRoZSAKbG9jaywgZXhwbGFpbmluZyB3aGF0IGl0IHByb3RlY3RzLCBvciB3 aXRoIHRoZSBkYXRhLCBub3Rpbmcgd2hpY2ggbG9jayAKcHJvdGVjdHMgaXQsIG9yIGJvdGggLS0g aW4gd2hpY2ggY2FzZSB0aGV5IHNob3VsZCBhZ3JlZSEKCj4+ICsgICAgPC9wYXJhPgo+PiArICAg IDxwYXJhPgo+PiArICAgICAgRnVuY3Rpb25zIHdoaWNoIGhhdmUgYSBub24tPGNvZGU+dm9pZDwv Y29kZT4gcmV0dXJuIHZhbHVlIHNob3VsZCBoYXZlIGEKPj4gKyAgICAgIHNlY3Rpb24gY2FsbGVk ICJSZXR1cm5zIiBleHBsYWluaW5nIHRoZSBleHBlY3RlZCByZXR1cm4gdmFsdWVzIGluCj4+ICsg ICAgICBkaWZmZXJlbnQgY2FzZXMgYW5kIHRoZWlyIG1lYW5pbmdzLiBDdXJyZW50bHkgdGhlcmUn cyBubyBjb25zZW5zdXMgd2hldGhlcgo+PiArICAgICAgdGhhdCBzZWN0aW9uIG5hbWUgc2hvdWxk IGJlIGFsbCB1cHBlci1jYXNlIG9yIG5vdCwgYW5kIHdoZXRoZXIgaXQgc2hvdWxkCj4+ICsgICAg ICBlbmQgaW4gYSBjb2xvbiBvciBub3QuIEdvIHdpdGggdGhlIGZpbGUtbG9jYWwgc3R5bGUuIE90 aGVyIGNvbW1vbiBzZWN0aW9uCj4KPiBJIHRob3VnaHQgdGhlIGNvbG9uIHdhcyBuZWNlc3Nhcnkg Zm9yIGtlcm5lbGRvYyB0byB0dXJuIGl0IGludG8gYQo+IHNlY3Rpb24/Cj4KPiBPdmVyYWxsLCBs b25nIG92ZXJkdWUsIHNvIHRoYW5rcyBmb3Igd3JpdGluZyBpdCB1cDoKPgo+IEFja2VkLWJ5OiBU aGllcnJ5IFJlZGluZyA8dHJlZGluZ0BudmlkaWEuY29tPgo+Cj4KPgo+IF9fX19fX19fX19fX19f X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fCj4gSW50ZWwtZ2Z4IG1haWxpbmcgbGlz dAo+IEludGVsLWdmeEBsaXN0cy5mcmVlZGVza3RvcC5vcmcKPiBodHRwOi8vbGlzdHMuZnJlZWRl c2t0b3Aub3JnL21haWxtYW4vbGlzdGluZm8vaW50ZWwtZ2Z4Cj4KCl9fX19fX19fX19fX19fX19f X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fCkludGVsLWdmeCBtYWlsaW5nIGxpc3QKSW50 ZWwtZ2Z4QGxpc3RzLmZyZWVkZXNrdG9wLm9yZwpodHRwOi8vbGlzdHMuZnJlZWRlc2t0b3Aub3Jn L21haWxtYW4vbGlzdGluZm8vaW50ZWwtZ2Z4Cg==