From mboxrd@z Thu Jan 1 00:00:00 1970 From: Pierre Moreau Subject: Re: [PATCH 1/5] [RFC] drm: Documentation style guide Date: Tue, 8 Dec 2015 10:59:05 +0100 Message-ID: <20151208095905.GA5523@Sovereign.cs.lth.se> References: <1449564561-3896-1-git-send-email-daniel.vetter@ffwll.ch> Mime-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Return-path: Content-Disposition: inline In-Reply-To: <1449564561-3896-1-git-send-email-daniel.vetter@ffwll.ch> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" To: Daniel Vetter Cc: Daniel Vetter , Intel Graphics Development , DRI Development List-Id: dri-devel@lists.freedesktop.org SGVsbG8gRGFuaWVsLAoKSnVzdCBzb21lIHR5cG8gY29tbWVudHMgYmVsb3cuCgpPbiAwOTo0OSBB TSAtIERlYyAwOCAyMDE1LCBEYW5pZWwgVmV0dGVyIHdyb3RlOgo+IEV2ZXJ5IHRpbWUgSSB0eXBl IG9yIHJldmlldyBkb2NzIHRoaXMgc2VlbXMgYSBiaXQgZGlmZmVyZW50LiBUcnkgdG8KPiBkb2N1 bWVudCB0aGUgY29tbW9uIHN0eWxlIHNvIHdlIGNhbiB0cnkgdG8gdW5pZnkgYXQgbGVhc3QgbmV3 IGRvY3MuCj4gCj4gU2lnbmVkLW9mZi1ieTogRGFuaWVsIFZldHRlciA8ZGFuaWVsLnZldHRlckBp bnRlbC5jb20+Cj4gLS0tCj4gIERvY3VtZW50YXRpb24vRG9jQm9vay9ncHUudG1wbCB8IDM3ICsr KysrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysKPiAgMSBmaWxlIGNoYW5nZWQsIDM3 IGluc2VydGlvbnMoKykKPiAKPiBkaWZmIC0tZ2l0IGEvRG9jdW1lbnRhdGlvbi9Eb2NCb29rL2dw dS50bXBsIGIvRG9jdW1lbnRhdGlvbi9Eb2NCb29rL2dwdS50bXBsCj4gaW5kZXggODZlNWIxMmE0 OWJhLi41Njk4YzkzZGFlOGIgMTAwNjQ0Cj4gLS0tIGEvRG9jdW1lbnRhdGlvbi9Eb2NCb29rL2dw dS50bXBsCj4gKysrIGIvRG9jdW1lbnRhdGlvbi9Eb2NCb29rL2dwdS50bXBsCj4gQEAgLTEyNCw2 ICsxMjQsNDMgQEAKPiAgICAgIDxwYXJhPgo+ICAgICAgICBbSW5zZXJ0IGRpYWdyYW0gb2YgdHlw aWNhbCBEUk0gc3RhY2sgaGVyZV0KPiAgICAgIDwvcGFyYT4KPiArICA8c2VjdDE+Cj4gKyAgICA8 dGl0bGU+U3R5bGUgR3VpZGVsaW5lczwvdGl0bGU+Cj4gKyAgICA8cGFyYT4KPiArICAgICAgRm9y IGNvbnNpc3RlbmN5IHRoZXNlIGRvY3VtZW50YXRpb25zIHVzZSBBbWVyaWNhbiBFbmdsaXNoLiBB YmJyZXZpYXRpb25zCj4gKyAgICAgIGFyZSB3cml0dGVuIGFzIGFsbC11cHBlcmNhc2UsIGZvciBl eGFtcGxlOiBEUk0sIEtNUywgSU9DVEwsIENSVEMsIGFuZCBzbwo+ICsgICAgICBvbi4gVG8gYWlk IGluIHJlYWRpbmcgZG9jdW1lbnRhdGlvbnMgbWFrZSBmdWxsIHVzZSBvZiB0aGUgbWFya3VwCj4g KyAgICAgIGNoYXJhY3RlcnMga2VybmVsZG9jIHByb3ZpZGVzOiBAcGFyYW1ldGVyIGZvciBmdW5j dGlvbiBwYXJhbXRlcnMsIEBtZW1iZXIKCnBhcmFtdGVycyAtPiBwYXJhbWV0ZXJzCgo+ICsgICAg ICBmb3Igc3RydWN0dXJlIG1lbWJlcnMsICZhbXA7c3RydWN0dXJlIHRvIHJlZmVybmNlIHN0cnVj dHVyZXMgYW5kCgpyZWZlcm5jZSAtPiByZWZlcmVuY2UKCj4gKyAgICAgIGZ1bmN0aW9uKCkgZm9y IGZ1bmN0aW9ucy4gVGhlc2UgYWxsIGdldCBhdXRvbWF0aWNhbGx5IGh5cGVybGlua2VkIGlmCj4g KyAgICAgIGtlcm5lbGRvYyBmb3IgdGhlIHJlZmVyZW5jZWMgb2JqZWN0cyBleGlzdHMgV2hlbiBy ZWZlcmVuY2luZyBlbnRyaWVzIGluCgpyZWZlcmVuY2VjIC0+IHJlZmVyZW5jZWQsIG1pc3Npbmcg Jy4nIGFmdGVyIGV4aXN0cwoKPiArICAgICAgZnVuY3Rpb24gdnRhYmxlcyBwbGVhc2UgdXNlIC0m bHQ7dmZ1bmMoKS4gTm90ZSB0aGF0IHdpdGgga2VybmVsZG9jIGRvZXMKCklzbid0ICJ3aXRoIiB0 b28gbXVjaCBoZXJlPyAiTm90ZSB0aGF0IGtlcm5lbGRvYyBkb2VzIG5vdCBb4oCmXSI/Cgo+ICsg ICAgICBub3Qgc3VwcG9ydCByZWZlcm5jaW5nIHN0cnVjdCBtZW1iZXJzIGRpcmVjdGx5LCBzbyBw bGVhc2UgYWRkIGEgcmVmZXJlbmNlCgpyZWZlcm5jaW5nIC0+IHJlZmVyZW5jaW5nCgo+ICsgICAg ICB0byB0aGUgdnRhYmxlIHN0cnVjdCBzb21ld2hlcmUgaW4gdGhlIHNhbWUgcGFyYWdyYXBoIG9y IGF0IGxlYXN0IHNlY3Rpb24uCj4gKyAgICA8L3BhcmE+Cj4gKyAgICA8cGFyYT4KPiArICAgICAg RXhjZXB0IGluIHNwZWNpYWwgc2l0dWF0aW9ucyAodG8gc2VwYXJhdGUgbG9ja2VkIGZyb20gdW5s b2NrZWQgdmFyaWFudHMpCj4gKyAgICAgIGxvY2tpbmcgcmVxdWlyZW1lbnRzIGZvciBmdW5jdGlv bnMgYXJlbid0IGRvY3VtZW50ZWQgaW4gdGhlIGtlcm5lbGRvYy4KPiArICAgICAgSW5zdGVhZCBs b2NraW5nIHNob3VsZCBiZSBjaGVjayBhdCBydW50aW1lIHVzaW5nIGUuZy4KPiArICAgICAgPGNv ZGU+V0FSTl9PTighbXV0ZXhfaXNfbG9ja2VkKC4uLikpOzwvY29kZT4uIFNpbmNlIGl0J3MgbXVj aCBlYXNpZXIgdG8KPiArICAgICAgaWdub3JlIGRvY3VtZW50YXRpb24gdGhhbiBydW50aW1lIG5v aXNlIHRoaXMgcHJvdmlkZXMgbW9yZSB2YWx1ZS4gQW5kIG9uCj4gKyAgICAgIHRvcCBvZiB0aGF0 IHJ1bnRpbWUgY2hlY2tzIGRvIG5lZWQgdG8gYmUgdXBkYXRlZCB3aGVuIHRoZSBsb2NraW5nIHJ1 bGVzCj4gKyAgICAgIGNoYW5nZSwgaW5jcmVhc2luZyB0aGUgY2hhbmdlcyB0aGF0IHRoZXkncmUg Y29ycmVjdC4gV2l0aGluIHRoZQo+ICsgICAgICBkb2N1bWVudGF0aW9uIHRoZSBsb2NraW5nIHJ1 bGVzIHNob3VsZCBiZSBleHBsYWluZWQgaW4gdGhlIHJlbGV2YW50Cj4gKyAgICAgIHN0cnVjdHVy ZXM6IEVpdGhlciBpbiB0aGUgY29tbWVudCBmb3IgdGhlIGxvY2sgZXhwbGFpbmluZyB3aGF0IGl0 Cj4gKyAgICAgIHByb3RlY3RzLCBvciBkYXRhIGZpZWxkcyBuZWVkIGEgbm90ZSBhYm91dCB3aGlj aCBsb2NrIHByb3RlY3RzIHRoZW0sIG9yCj4gKyAgICAgIGJvdGguCj4gKyAgICA8L3BhcmE+Cj4g KyAgICA8cGFyYT4KPiArICAgICAgRnVuY3Rpb25zIHdoaWNoIGhhdmUgYSBub24tPGNvZGU+dm9p ZDwvY29kZT4gcmV0dXJuIHZhbHVlIHNob3VsZCBoYXZlIGEKPiArICAgICAgc2VjdGlvbiBjYWxs ZWQgIlJldHVybnMiIGV4cGxhaW5pbmcgdGhlIGV4cGVjdGVkIHJldHVybiB2YWx1ZXMgaW4KPiAr ICAgICAgZGlmZmVyZW50IGNhc2VzIGFuIHRoZWlyIG1lYW5pbmdzLiBDdXJyZW50bHkgdGhlcmUn cyBubyBjb25zZW5zdXMgd2hldGhlcgo+ICsgICAgICB0aGF0IHNlY3Rpb24gbmFtZSBzaG91bGQg YmUgYWxsIHVwcGVyLWNhc2Ugb3Igbm90LCBhbmQgd2hldGhlciBpdCBzaG91bGQKPiArICAgICAg ZW5kIGluIGEgY29sb24gb3Igbm90LiBHbyB3aXRoIHRoZSBmaWxlLWxvY2FsIHN0eWxlLiBPdGhl ciBjb21tb24gc2VjdGlvbgo+ICsgICAgICBuYW1lcyBhcmUgIk5vdGVzIiB3aXRoIGluZm9ybWF0 aW9uIGZvciBkYW5nZXJvdXMgb3IgdHJpY2t5IGNvcm5lciBjYXNlcywKPiArICAgICAgYW5kICJG SVhNRSIgd2hlcmUgdGhlIGludGVyZmFjZSBjb3VsZCBiZSBjbGVhbmVkIHVwLgoKV2h5IG5vdCBk ZWZpbmUgKGFuZCB1c2UpIGEgc2luZ2xlIHN0eWxlIGZvciBuYW1pbmcgYWxsIHNlY3Rpb25zPyBP bGQKZG9jdW1lbnRhdGlvbiBtaWdodCBub3QgdXNlIGl0LCBidXQgaXQgc2hvdWxkIGJlIGRvYWJs ZSB0byB1cGdyYWRlIHRob3NlIG9sZApkb2N1bWVudHMuCgpQaWVycmUKCgo+ICsgICAgPC9wYXJh Pgo+ICsgIDwvc2VjdDE+Cj4gICAgPC9jaGFwdGVyPgo+ICAKPiAgICA8IS0tIEludGVybmFscyAt LT4KPiAtLSAKPiAyLjUuMQo+IAo+IF9fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19f X19fX19fX19fX19fCj4gZHJpLWRldmVsIG1haWxpbmcgbGlzdAo+IGRyaS1kZXZlbEBsaXN0cy5m cmVlZGVza3RvcC5vcmcKPiBodHRwOi8vbGlzdHMuZnJlZWRlc2t0b3Aub3JnL21haWxtYW4vbGlz dGluZm8vZHJpLWRldmVsCl9fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19f X19fX19fCmRyaS1kZXZlbCBtYWlsaW5nIGxpc3QKZHJpLWRldmVsQGxpc3RzLmZyZWVkZXNrdG9w Lm9yZwpodHRwOi8vbGlzdHMuZnJlZWRlc2t0b3Aub3JnL21haWxtYW4vbGlzdGluZm8vZHJpLWRl dmVsCg==