From mboxrd@z Thu Jan 1 00:00:00 1970 From: Daniel Vetter Subject: Re: [PATCH] drm: Documentation style guide Date: Tue, 15 Dec 2015 17:09:59 +0100 Message-ID: <20151215160959.GC30437@phenom.ffwll.local> References: <20151209151942.GA29631@wunner.de> <1449677282-30832-1-git-send-email-daniel.vetter@ffwll.ch> <20151214153906.GB1998@ulmo> <56702A0A.5060900@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Return-path: Received: from mail-wm0-f49.google.com (mail-wm0-f49.google.com [74.125.82.49]) by gabe.freedesktop.org (Postfix) with ESMTPS id B248F6E73F for ; Tue, 15 Dec 2015 08:10:04 -0800 (PST) Received: by mail-wm0-f49.google.com with SMTP id n186so102141772wmn.0 for ; Tue, 15 Dec 2015 08:10:04 -0800 (PST) Content-Disposition: inline In-Reply-To: <56702A0A.5060900@intel.com> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" To: Dave Gordon Cc: Daniel Vetter , Intel Graphics Development , DRI Development , Thierry Reding , Laurent Pinchart , Daniel Vetter List-Id: intel-gfx@lists.freedesktop.org T24gVHVlLCBEZWMgMTUsIDIwMTUgYXQgMDI6NTY6MTBQTSArMDAwMCwgRGF2ZSBHb3Jkb24gd3Jv dGU6Cj4gT24gMTQvMTIvMTUgMTU6MzksIFRoaWVycnkgUmVkaW5nIHdyb3RlOgo+ID5PbiBXZWQs IERlYyAwOSwgMjAxNSBhdCAwNTowODowMlBNICswMTAwLCBEYW5pZWwgVmV0dGVyIHdyb3RlOgo+ ID4+RXZlcnkgdGltZSBJIHR5cGUgb3IgcmV2aWV3IGRvY3MgdGhpcyBzZWVtcyBhIGJpdCBkaWZm ZXJlbnQuIFRyeSB0bwo+ID4+ZG9jdW1lbnQgdGhlIGNvbW1vbiBzdHlsZSBzbyB3ZSBjYW4gdHJ5 IHRvIHVuaWZ5IGF0IGxlYXN0IG5ldyBkb2NzLgo+ID4+Cj4gPj52MjogU3BlbGxpbmcgZml4ZXMg ZnJvbSBQaWVycmUsIExhdXJlbnQgYW5kIEphbmkuCj4gPj4KPiA+PnYzOiBNb3JlIHNwZWxsaW5n IGZpeGVzIGZyb20gTHVrYXMuCj4gPj4KPiA+PkNjOiBQaWVycmUgTW9yZWF1IDxwaWVycmUubW9y cm93QGZyZWUuZnI+Cj4gPj5DYzogSmFuaSBOaWt1bGEgPGphbmkubmlrdWxhQGxpbnV4LmludGVs LmNvbT4KPiA+PkNjOiBMYXVyZW50IFBpbmNoYXJ0IDxsYXVyZW50LnBpbmNoYXJ0QGlkZWFzb25i b2FyZC5jb20+Cj4gPj5DYzogTHVrYXMgV3VubmVyIDxsdWthc0B3dW5uZXIuZGU+Cj4gPj5BY2tl ZC1ieTogTGF1cmVudCBQaW5jaGFydCA8bGF1cmVudC5waW5jaGFydEBpZGVhc29uYm9hcmQuY29t Pgo+ID4+U2lnbmVkLW9mZi1ieTogRGFuaWVsIFZldHRlciA8ZGFuaWVsLnZldHRlckBpbnRlbC5j b20+Cj4gPj5MaW5rOiBodHRwOi8vcGF0Y2h3b3JrLmZyZWVkZXNrdG9wLm9yZy9wYXRjaC9tc2dp ZC8xNDQ5NTY0NTYxLTM4OTYtMS1naXQtc2VuZC1lbWFpbC1kYW5pZWwudmV0dGVyQGZmd2xsLmNo Cj4gPj4tLS0KPiA+PiAgRG9jdW1lbnRhdGlvbi9Eb2NCb29rL2dwdS50bXBsIHwgMzcgKysrKysr KysrKysrKysrKysrKysrKysrKysrKysrKysrKysrKwo+ID4+ICAxIGZpbGUgY2hhbmdlZCwgMzcg aW5zZXJ0aW9ucygrKQo+ID4+Cj4gPj5kaWZmIC0tZ2l0IGEvRG9jdW1lbnRhdGlvbi9Eb2NCb29r L2dwdS50bXBsIGIvRG9jdW1lbnRhdGlvbi9Eb2NCb29rL2dwdS50bXBsCj4gPj5pbmRleCA3NDli OGUyZjIxMTMuLmM2NmQ2NDEyZjU3MyAxMDA2NDQKPiA+Pi0tLSBhL0RvY3VtZW50YXRpb24vRG9j Qm9vay9ncHUudG1wbAo+ID4+KysrIGIvRG9jdW1lbnRhdGlvbi9Eb2NCb29rL2dwdS50bXBsCj4g Pj5AQCAtMTI0LDYgKzEyNCw0MyBAQAo+ID4+ICAgICAgPHBhcmE+Cj4gPj4gICAgICAgIFtJbnNl cnQgZGlhZ3JhbSBvZiB0eXBpY2FsIERSTSBzdGFjayBoZXJlXQo+ID4+ICAgICAgPC9wYXJhPgo+ ID4+KyAgPHNlY3QxPgo+ID4+KyAgICA8dGl0bGU+U3R5bGUgR3VpZGVsaW5lczwvdGl0bGU+Cj4g Pj4rICAgIDxwYXJhPgo+ID4+KyAgICAgIEZvciBjb25zaXN0ZW5jeSB0aGlzIGRvY3VtZW50YXRp b24gdXNlcyBBbWVyaWNhbiBFbmdsaXNoLiBBYmJyZXZpYXRpb25zCj4gPj4rICAgICAgYXJlIHdy aXR0ZW4gYXMgYWxsLXVwcGVyY2FzZSwgZm9yIGV4YW1wbGU6IERSTSwgS01TLCBJT0NUTCwgQ1JU QywgYW5kIHNvCj4gPj4rICAgICAgb24uIFRvIGFpZCBpbiByZWFkaW5nLCBkb2N1bWVudGF0aW9u cyBtYWtlIGZ1bGwgdXNlIG9mIHRoZSBtYXJrdXAKPiA+Cj4gPiIuLi4sIHRoZSBkb2N1bWVudGF0 aW9uIG1ha2VzIGZ1bGwgdXNlIG9mLi4uIiBhbmQgcGVyaGFwcyAibWFrZXMgdXNlIG9mCj4gPnRo ZSBmdWxsIHNldCBvZiBtYXJrdXAgY2hhcmFjdGVycyB0aGF0IGtlcm5lbGRvYyBwcm92aWRlcyIu Cj4gPgo+ID4+KyAgICAgIGNoYXJhY3RlcnMga2VybmVsZG9jIHByb3ZpZGVzOiBAcGFyYW1ldGVy IGZvciBmdW5jdGlvbiBwYXJhbWV0ZXJzLCBAbWVtYmVyCj4gPj4rICAgICAgZm9yIHN0cnVjdHVy ZSBtZW1iZXJzLCAmYW1wO3N0cnVjdHVyZSB0byByZWZlcmVuY2Ugc3RydWN0dXJlcyBhbmQKPiA+ PisgICAgICBmdW5jdGlvbigpIGZvciBmdW5jdGlvbnMuIFRoZXNlIGFsbCBnZXQgYXV0b21hdGlj YWxseSBoeXBlcmxpbmtlZCBpZgo+ID4+KyAgICAgIGtlcm5lbGRvYyBmb3IgdGhlIHJlZmVyZW5j ZWQgb2JqZWN0cyBleGlzdHMuIFdoZW4gcmVmZXJlbmNpbmcgZW50cmllcyBpbgo+ID4+KyAgICAg IGZ1bmN0aW9uIHZ0YWJsZXMgcGxlYXNlIHVzZSAtJmd0O3ZmdW5jKCkuIE5vdGUgdGhhdCBrZXJu ZWxkb2MgZG9lcwo+ID4+KyAgICAgIG5vdCBzdXBwb3J0IHJlZmVyZW5jaW5nIHN0cnVjdCBtZW1i ZXJzIGRpcmVjdGx5LCBzbyBwbGVhc2UgYWRkIGEgcmVmZXJlbmNlCj4gPj4rICAgICAgdG8gdGhl IHZ0YWJsZSBzdHJ1Y3Qgc29tZXdoZXJlIGluIHRoZSBzYW1lIHBhcmFncmFwaCBvciBhdCBsZWFz dCBzZWN0aW9uLgo+ID4+KyAgICA8L3BhcmE+Cj4gPj4rICAgIDxwYXJhPgo+ID4+KyAgICAgIEV4 Y2VwdCBpbiBzcGVjaWFsIHNpdHVhdGlvbnMgKHRvIHNlcGFyYXRlIGxvY2tlZCBmcm9tIHVubG9j a2VkIHZhcmlhbnRzKQo+ID4+KyAgICAgIGxvY2tpbmcgcmVxdWlyZW1lbnRzIGZvciBmdW5jdGlv bnMgYXJlbid0IGRvY3VtZW50ZWQgaW4gdGhlIGtlcm5lbGRvYy4KPiA+PisgICAgICBJbnN0ZWFk IGxvY2tpbmcgc2hvdWxkIGJlIGNoZWNrIGF0IHJ1bnRpbWUgdXNpbmcgZS5nLgo+ID4KPiA+InNo b3VsZCBiZSBjaGVja2VkIgo+ID4KPiA+PisgICAgICA8Y29kZT5XQVJOX09OKCFtdXRleF9pc19s b2NrZWQoLi4uKSk7PC9jb2RlPi4gU2luY2UgaXQncyBtdWNoIGVhc2llciB0bwo+ID4+KyAgICAg IGlnbm9yZSBkb2N1bWVudGF0aW9uIHRoYW4gcnVudGltZSBub2lzZSB0aGlzIHByb3ZpZGVzIG1v cmUgdmFsdWUuIEFuZCBvbgo+ID4+KyAgICAgIHRvcCBvZiB0aGF0IHJ1bnRpbWUgY2hlY2tzIGRv IG5lZWQgdG8gYmUgdXBkYXRlZCB3aGVuIHRoZSBsb2NraW5nIHJ1bGVzCj4gPj4rICAgICAgY2hh bmdlLCBpbmNyZWFzaW5nIHRoZSBjaGFuY2VzIHRoYXQgdGhleSdyZSBjb3JyZWN0LiBXaXRoaW4g dGhlCj4gCj4gQSBmZXcgY29tbWFzIHRvIGRlbGltaXQgc3ViY2xhdXNlcyB3b3VsZCBtYWtlIHRo aXMgbW9yZSByZWFkYWJsZToKPiAKPiBTaW5jZSBpdCdzIG11Y2ggZWFzaWVyIHRvIGlnbm9yZSBk b2N1bWVudGF0aW9uIHRoYW4gcnVudGltZSBub2lzZSwgdGhpcwo+IHByb3ZpZGVzIG1vcmUgdmFs dWUuIEFuZCBvbiB0b3Agb2YgdGhhdCwgcnVudGltZSBjaGVja3MgaGF2ZSB0byBiZSB1cGRhdGVk Cj4gd2hlbiB0aGUgbG9ja2luZyBydWxlcyBjaGFuZ2UsIHRodXMgaW5jcmVhc2luZyB0aGUgY2hh bmNlcyB0aGF0IHRoZXkncmUKPiBjb3JyZWN0Lgo+IAo+ID4+KyAgICAgIGRvY3VtZW50YXRpb24g dGhlIGxvY2tpbmcgcnVsZXMgc2hvdWxkIGJlIGV4cGxhaW5lZCBpbiB0aGUgcmVsZXZhbnQKPiA+ PisgICAgICBzdHJ1Y3R1cmVzOiBFaXRoZXIgaW4gdGhlIGNvbW1lbnQgZm9yIHRoZSBsb2NrIGV4 cGxhaW5pbmcgd2hhdCBpdAo+ID4+KyAgICAgIHByb3RlY3RzLCBvciBkYXRhIGZpZWxkcyBuZWVk IGEgbm90ZSBhYm91dCB3aGljaCBsb2NrIHByb3RlY3RzIHRoZW0sIG9yCj4gPj4rICAgICAgYm90 aC4KPiA+Cj4gPkkgdGhpbmsgeW91J3JlIHN1cHBvc2VkIHRvIGhhdmUgdGhlICJvciIgb25seSBp biB0aGUgZmluYWwgc3Vic2VudGVuY2U6Cj4gPgo+ID4JImVpdGhlciAuLi4gcHJvdGVjdHMsIGRh dGEgZmllbGRzIG5lZWQgLi4uLCBvciBib3RoLiIKPiAKPiBXaXRoaW4gdGhlIGRvY3VtZW50YXRp b24sIHRoZSBsb2NraW5nIHJ1bGVzIHNob3VsZCBiZSBleHBsYWluZWQgaW4gY29tbWVudHMKPiBv biB0aGUgcmVsZXZhbnQgc3RydWN0dXJlczsgdGhlc2UgY29tbWVudHMgbWF5IGJlIHdpdGggdGhl IGxvY2ssIGV4cGxhaW5pbmcKPiB3aGF0IGl0IHByb3RlY3RzLCBvciB3aXRoIHRoZSBkYXRhLCBu b3Rpbmcgd2hpY2ggbG9jayBwcm90ZWN0cyBpdCwgb3IgYm90aAo+IC0tIGluIHdoaWNoIGNhc2Ug dGhleSBzaG91bGQgYWdyZWUhCj4gCj4gPj4rICAgIDwvcGFyYT4KPiA+PisgICAgPHBhcmE+Cj4g Pj4rICAgICAgRnVuY3Rpb25zIHdoaWNoIGhhdmUgYSBub24tPGNvZGU+dm9pZDwvY29kZT4gcmV0 dXJuIHZhbHVlIHNob3VsZCBoYXZlIGEKPiA+PisgICAgICBzZWN0aW9uIGNhbGxlZCAiUmV0dXJu cyIgZXhwbGFpbmluZyB0aGUgZXhwZWN0ZWQgcmV0dXJuIHZhbHVlcyBpbgo+ID4+KyAgICAgIGRp ZmZlcmVudCBjYXNlcyBhbmQgdGhlaXIgbWVhbmluZ3MuIEN1cnJlbnRseSB0aGVyZSdzIG5vIGNv bnNlbnN1cyB3aGV0aGVyCj4gPj4rICAgICAgdGhhdCBzZWN0aW9uIG5hbWUgc2hvdWxkIGJlIGFs bCB1cHBlci1jYXNlIG9yIG5vdCwgYW5kIHdoZXRoZXIgaXQgc2hvdWxkCj4gPj4rICAgICAgZW5k IGluIGEgY29sb24gb3Igbm90LiBHbyB3aXRoIHRoZSBmaWxlLWxvY2FsIHN0eWxlLiBPdGhlciBj b21tb24gc2VjdGlvbgo+ID4KPiA+SSB0aG91Z2h0IHRoZSBjb2xvbiB3YXMgbmVjZXNzYXJ5IGZv ciBrZXJuZWxkb2MgdG8gdHVybiBpdCBpbnRvIGEKPiA+c2VjdGlvbj8KPiA+Cj4gPk92ZXJhbGws IGxvbmcgb3ZlcmR1ZSwgc28gdGhhbmtzIGZvciB3cml0aW5nIGl0IHVwOgo+ID4KPiA+QWNrZWQt Ynk6IFRoaWVycnkgUmVkaW5nIDx0cmVkaW5nQG52aWRpYS5jb20+CgpVbmZvcnR1bmF0ZWx5IHB1 bGwgcmVxdWVzdCB3aXRoIHRoaXMgYWxyZWFkeSB3ZW50IHRvIERhdmUgYmVmb3JlIEkgY291bGQK dGFrZSB5b3VyIGZlZWRiYWNrIGludG8gYWNjb3VudC4gQW55b25lIHVwIGZvciBhIHF1aWNrIGZv bGxvdy11cCBwYXRjaAp0aGF0IEkgY291bGQgdmFjdXVtIHVwIGluIHRpbWUgZm9yIDQuNSAoaS5l LiB1bnRpbCBUaHUgbGF0ZXN0KT8KClRoYW5rcywgRGFuaWVsCi0tIApEYW5pZWwgVmV0dGVyClNv ZnR3YXJlIEVuZ2luZWVyLCBJbnRlbCBDb3Jwb3JhdGlvbgpodHRwOi8vYmxvZy5mZndsbC5jaApf X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fXwpJbnRlbC1nZngg bWFpbGluZyBsaXN0CkludGVsLWdmeEBsaXN0cy5mcmVlZGVza3RvcC5vcmcKaHR0cDovL2xpc3Rz LmZyZWVkZXNrdG9wLm9yZy9tYWlsbWFuL2xpc3RpbmZvL2ludGVsLWdmeAo=