From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) by finch.gentoo.org (Postfix) with ESMTP id 7A63313827B for ; Thu, 3 Jan 2013 13:02:36 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 39A8E21C0E3; Thu, 3 Jan 2013 13:02:18 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 12F6021C0D6 for ; Thu, 3 Jan 2013 13:01:10 +0000 (UTC) Received: from [192.168.1.204] (50.151.16.95.dynamic.jazztel.es [95.16.151.50]) (using TLSv1 with cipher ECDHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) (Authenticated sender: pacho) by smtp.gentoo.org (Postfix) with ESMTPSA id 1484633D751 for ; Thu, 3 Jan 2013 13:01:08 +0000 (UTC) Subject: [gentoo-dev] configuration-doc.eclass: an eclass to install a CONFIGURATION doc file and show an elog message first time package is installed From: Pacho Ramos To: gentoo-dev@lists.gentoo.org Content-Type: multipart/signed; micalg="pgp-sha1"; protocol="application/pgp-signature"; boundary="=-6eWlz+iZWaR8NyO0DuN+" Date: Thu, 03 Jan 2013 14:01:03 +0100 Message-ID: <1357218063.26280.68.camel@belkin4> Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@lists.gentoo.org Reply-to: gentoo-dev@lists.gentoo.org Mime-Version: 1.0 X-Mailer: Evolution 2.32.3 X-Archives-Salt: d90c81f6-167d-4496-b2c0-7cf62a2a1c7b X-Archives-Hash: 2de035aa5bba56041a980a0a4d44055c --=-6eWlz+iZWaR8NyO0DuN+ Content-Type: multipart/mixed; boundary="=-NGEck0XclIpqi4Z9DHUt" --=-NGEck0XclIpqi4Z9DHUt Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable This comes from the following gentoo-dev thread: http://www.gossamer-threads.com/lists/gentoo/dev/264888 Its usage will lead to the installation of a CONFIGURATION file under /usr/share/doc/${PF} and show of elog messages with its content first time package is installed, relying in doc file for future installations or people simply going there to review configuration tips. I also attach acpid ebuild as example. Currently I have doubts about how to handle formatting, it is now using "fmt" as kernel-2.eclass to format it and, then, you can set: CONFIGURATION_INSTRUCTIONS=3D" You may wish to read the Gentoo Linux Power Management Guide, which can be found online at: http://www.gentoo.org/doc/en/power-management-guide.xml" and it will be properly formatted at the end. The problem is that I find no way to force a jump to a new line (for example if somebody want to show a command to run in a new line). Other option would be to simply add quotes to: echo ${CONFIGURATION_INSTRUCTIONS} and drop "fmt" usage. It will respect formatting specified in ebuild, but this needs to be taken into account as, for example, acpid ebuild used as example should be changed to use: CONFIGURATION_INSTRUCTIONS=3D"You may wish to read the Gentoo Linux Power Management Guide, which can be found online at: http://www.gentoo.org/doc/en/power-management-guide.xml" or people will get an empty line at the top of the messages. Maybe an option to toggle fmt/formatting usage could be used, but I am unsure about how to handle it at eclass level in a "short" way (I could add some "ifs" running either variant (with quotes or without them and fmt usage), but not sure if a shorter way could be used) --=-NGEck0XclIpqi4Z9DHUt Content-Disposition: attachment; filename="configuration-doc.eclass" Content-Transfer-Encoding: base64 Content-Type: text/plain; name="configuration-doc.eclass"; charset="UTF-8" IyBDb3B5cmlnaHQgMTk5OS0yMDEyIEdlbnRvbyBGb3VuZGF0aW9uDQojIERpc3RyaWJ1dGVkIHVu ZGVyIHRoZSB0ZXJtcyBvZiB0aGUgR05VIEdlbmVyYWwgUHVibGljIExpY2Vuc2UgdjINCiMgJEhl YWRlcjogJA0KDQojIEBFQ0xBU1M6IGNvbmZpZ3VyYXRpb24tZG9jDQojIEBNQUlOVEFJTkVSOg0K IyBQYWNobyBSYW1vcyA8cGFjaG9AZ2VudG9vLm9yZz4NCiMgQEFVVEhPUjoNCiMgQXV0aG9yOiBQ YWNobyBSYW1vcyA8cGFjaG9AZ2VudG9vLm9yZz4NCiMgQEJMVVJCOiBBbiBlY2xhc3MgZm9yIGlu c3RhbGxpbmcgYSBDT05GSUdVUkFUSU9OIGRvYyBmaWxlIHJlY29yZGluZyB0aXBzDQojIHNob3du IHZpYSBlbG9nIG1lc3NhZ2VzLiBXaXRoIHRoaXMgZWNsYXNzLCB0aG9zZSBlbG9nIG1lc3NhZ2Vz IHdpbGwgb25seSBiZQ0KIyBzaG93biBhdCBmaXJzdCBwYWNrYWdlIGluc3RhbGxhdGlvbiBhbmQg YSBmaWxlIGZvciBsYXRlciByZXZpZXdpbmcgd2lsbCBiZQ0KIyBpbnN0YWxsZWQgdW5kZXIgL3Vz ci9zaGFyZS9kb2MvJHtQRn0NCiMgQERFU0NSSVBUSU9OOg0KIyBBbiBlY2xhc3MgZm9yIGluc3Rh bGxpbmcgYSBDT05GSUdVUkFUSU9OIGRvYyBmaWxlIHJlY29yZGluZyB0aXBzICAgICAgICAgICAN CiMgc2hvd24gdmlhIGVsb2cgbWVzc2FnZXMuIFdpdGggdGhpcyBlY2xhc3MsIHRob3NlIGVsb2cg bWVzc2FnZXMgd2lsbCBvbmx5IGJlDQojIHNob3duIGF0IGZpcnN0IHBhY2thZ2UgaW5zdGFsbGF0 aW9uIGFuZCBhIGZpbGUgZm9yIGxhdGVyIHJldmlld2luZyB3aWxsIGJlDQojIGluc3RhbGxlZCB1 bmRlciAvdXNyL3NoYXJlL2RvYy8ke1BGfQ0KDQppZiBbWyAke19fX0VDTEFTU19PTkNFX0NPTkZJ R1VSQVRJT05fRE9DfSAhPSAicmVjdXIgLV8rXitfLSBzcGFuayIgXV0gOyB0aGVuDQpfX19FQ0xB U1NfT05DRV9DT05GSUdVUkFUSU9OX0RPQz0icmVjdXIgLV8rXitfLSBzcGFuayINCg0KaW5oZXJp dCBldXRpbHMNCg0KY2FzZSAiJHtFQVBJOi0wfSIgaW4NCgkwfDF8MnwzKQ0KCQlkaWUgIlVuc3Vw cG9ydGVkIEVBUEk9JHtFQVBJOi0wfSAodG9vIG9sZCkgZm9yICR7RUNMQVNTfSINCgkJOzsNCgk0 fDUpDQoJCSMgRUFQST49NCBpcyByZXF1aXJlZCBmb3IgUkVQTEFDSU5HX1ZFUlNJT05TIHByZXZl bnRpbmcgdXMNCgkJIyBmcm9tIG5lZWRpbmcgdG8gZXhwb3J0IGFub3RoZXIgcGtnX3ByZWluc3Qg cGhhc2UgdG8gc2F2ZSBoYXNfdmVyc2lvbg0KCQkjIHJlc3VsdC4gQWxzbyByZWxpZXMgb24gRUFQ SSA+PTQgZGVmYXVsdCBzcmNfaW5zdGFsbCBwaGFzZS4NCgkJOzsNCgkqKQ0KCQlkaWUgIlVuc3Vw cG9ydGVkIEVBUEk9JHtFQVBJfSAodW5rbm93bikgZm9yICR7RUNMQVNTfSINCgkJOzsNCmVzYWMN Cg0KRVhQT1JUX0ZVTkNUSU9OUyBzcmNfaW5zdGFsbCBwa2dfcG9zdGluc3QNCg0KIyBARlVOQ1RJ T046IGNvbmZpZ3VyYXRpb25fY3JlYXRlX2RvYw0KIyBAREVTQ1JJUFRJT046DQojIENyZWF0ZSBk b2MgZmlsZSB3aXRoIENPTkZJR1VSQVRJT05fSU5TVFJVQ1RJT05TIGNvbnRlbnRzLg0KIyBVc3Vh bGx5IGNhbGxlZCBhdCBzcmNfaW5zdGFsbCBwaGFzZS4NCmNvbmZpZ3VyYXRpb25fY3JlYXRlX2Rv YygpIHsNCglkZWJ1Zy1wcmludC1mdW5jdGlvbiAke0ZVTkNOQU1FfSAiJHtAfSINCg0KCWlmIFtb IC1uICIke0NPTkZJR1VSQVRJT05fSU5TVFJVQ1RJT05TfSIgXV07IHRoZW4NCgkJZXNob3B0c19w dXNoDQoJCXNldCAtZg0KCQllY2hvICR7Q09ORklHVVJBVElPTl9JTlNUUlVDVElPTlN9IHwgZm10 ID4gQ09ORklHVVJBVElPTg0KCQllc2hvcHRzX3BvcA0KCQlkb2RvYyBDT05GSUdVUkFUSU9ODQoJ ZmkNCn0NCg0KIyBARlVOQ1RJT046IGNvbmZpZ3VyYXRpb25fcHJpbnRfZWxvZw0KIyBAREVTQ1JJ UFRJT046DQojIFByaW50IGVsb2cgbWVzc2FnZXMgd2l0aCBDT05GSUdVUkFUSU9OX0lOU1RSVUNU SU9OUyBjb250ZW50cy4NCiMgVXN1YWxseSBjYWxsZWQgYXQgcGtnX3Bvc3RpbnN0IHBoYXNlLg0K Y29uZmlndXJhdGlvbl9wcmludF9lbG9nKCkgew0KCWRlYnVnLXByaW50LWZ1bmN0aW9uICR7RlVO Q05BTUV9ICIke0B9Ig0KDQoJaWYgW1sgLW4gIiR7Q09ORklHVVJBVElPTl9JTlNUUlVDVElPTlN9 IiBdXTsgdGhlbg0KCQlpZiAhIFtbICIke1JFUExBQ0lOR19WRVJTSU9OU30iIF1dOyB0aGVuDQoJ CQllc2hvcHRzX3B1c2gNCgkJCXNldCAtZg0KCQkJZWNobyAke0NPTkZJR1VSQVRJT05fSU5TVFJV Q1RJT05TfSB8IGZtdCB8IHdoaWxlIHJlYWQgLXIgRUxJTkU7IGRvIGVsb2cgIiR7RUxJTkV9Ijsg ZG9uZQ0KCQkJZXNob3B0c19wb3ANCgkJZmkNCglmaQ0KfQ0KDQoNCiMgQEZVTkNUSU9OOiBjb25m aWd1cmF0aW9uLWRvY19zcmNfaW5zdGFsbA0KIyBAREVTQ1JJUFRJT046DQojIFNob3cgZWxvZyBt ZXNzYWdlcyBmcm9tIENPTkZJR1VSQVRJT05fSU5TVFJVQ1RJT05TIHZhcmlhYmxlLCB0aGF0IHdp bGwgYmUNCiMgc2hhcmVkIHdpdGggL3Vzci9zaGFyZS9kb2MvJHtQRn0vQ09ORklHVVJBVElPTiBj b250ZW50Lg0KY29uZmlndXJhdGlvbi1kb2Nfc3JjX2luc3RhbGwoKSB7DQoJZGVidWctcHJpbnQt ZnVuY3Rpb24gJHtGVU5DTkFNRX0gIiR7QH0iDQoNCglkZWZhdWx0DQoJY29uZmlndXJhdGlvbl9j cmVhdGVfZG9jDQp9DQoNCiMgQEZVTkNUSU9OOiBjb25maWd1cmF0aW9uLWRvY19wa2dfcG9zdGlu c3QNCiMgQERFU0NSSVBUSU9OOg0KIyBTaG93IGVsb2cgbWVzc2FnZXMgZnJvbSBDT05GSUdVUkFU SU9OX0lOU1RSVUNUSU9OUyB2YXJpYWJsZSwgdGhhdCB3aWxsIGJlDQojIHNoYXJlZCB3aXRoIC91 c3Ivc2hhcmUvZG9jLyR7UEZ9L0NPTkZJR1VSQVRJT04gY29udGVudC4NCmNvbmZpZ3VyYXRpb24t ZG9jX3BrZ19wb3N0aW5zdCgpIHsNCglkZWJ1Zy1wcmludC1mdW5jdGlvbiAke0ZVTkNOQU1FfSAi JHtAfSINCgljb25maWd1cmF0aW9uX3ByaW50X2Vsb2cNCn0NCg0KZmkNCg== --=-NGEck0XclIpqi4Z9DHUt Content-Disposition: attachment; filename="acpid-2.0.17.ebuild" Content-Transfer-Encoding: base64 Content-Type: text/plain; name="acpid-2.0.17.ebuild"; charset="UTF-8" IyBDb3B5cmlnaHQgMTk5OS0yMDEyIEdlbnRvbyBGb3VuZGF0aW9uDQojIERpc3RyaWJ1dGVkIHVu ZGVyIHRoZSB0ZXJtcyBvZiB0aGUgR05VIEdlbmVyYWwgUHVibGljIExpY2Vuc2UgdjINCiMgJEhl YWRlcjogL3Zhci9jdnNyb290L2dlbnRvby14ODYvc3lzLXBvd2VyL2FjcGlkL2FjcGlkLTIuMC4x Ny5lYnVpbGQsdiAxLjYgMjAxMi8xMS8yNSAxODo1OToyNSBhcm1pbjc2IEV4cCAkDQoNCkVBUEk9 NA0KaW5oZXJpdCBjb25maWd1cmF0aW9uLWRvYyBzeXN0ZW1kDQoNCkRFU0NSSVBUSU9OPSJEYWVt b24gZm9yIEFkdmFuY2VkIENvbmZpZ3VyYXRpb24gYW5kIFBvd2VyIEludGVyZmFjZSINCkhPTUVQ QUdFPSJodHRwOi8vdGVkZmVsaXguY29tL2xpbnV4L2FjcGlkLW5ldGxpbmsuaHRtbCINClNSQ19V Ukk9Imh0dHA6Ly90ZWRmZWxpeC5jb20vbGludXgvJHtQfS50YXIueHoiDQoNCkxJQ0VOU0U9IkdQ TC0yIg0KU0xPVD0iMCINCktFWVdPUkRTPSJhbWQ2NCBpYTY0IC1wcGMgeDg2Ig0KSVVTRT0ic2Vs aW51eCINCg0KUkRFUEVORD0ic2VsaW51eD8gKCBzZWMtcG9saWN5L3NlbGludXgtYXBtICkiDQpE RVBFTkQ9IiR7UkRFUEVORH0iDQoNCkNPTkZJR1VSQVRJT05fSU5TVFJVQ1RJT05TPSINCglZb3Ug bWF5IHdpc2ggdG8gcmVhZCB0aGUgR2VudG9vIExpbnV4IFBvd2VyIE1hbmFnZW1lbnQgR3VpZGUs DQoJd2hpY2ggY2FuIGJlIGZvdW5kIG9ubGluZSBhdDoNCglodHRwOi8vd3d3LmdlbnRvby5vcmcv ZG9jL2VuL3Bvd2VyLW1hbmFnZW1lbnQtZ3VpZGUueG1sIg0KDQpzcmNfY29uZmlndXJlKCkgew0K CWVjb25mIC0tZG9jZGlyPS91c3Ivc2hhcmUvZG9jLyR7UEZ9DQp9DQoNCnNyY19pbnN0YWxsKCkg ew0KCWVtYWtlIERFU1RESVI9IiR7RH0iIGluc3RhbGwNCg0KCW5ld2RvYyBrYWNwaW1vbi9SRUFE TUUgUkVBRE1FLmthY3BpbW9uDQoJZG9kb2MgLXIgc2FtcGxlcw0KCXJtIC1mICIke0R9Ii91c3Iv c2hhcmUvZG9jLyR7UEZ9L0NPUFlJTkcNCg0KCWV4ZWludG8gL2V0Yy9hY3BpDQoJbmV3ZXhlICIk e0ZJTEVTRElSfSIvJHtQTn0tMS4wLjYtZGVmYXVsdC5zaCBkZWZhdWx0LnNoDQoJaW5zaW50byAv ZXRjL2FjcGkvZXZlbnRzDQoJbmV3aW5zICIke0ZJTEVTRElSfSIvJHtQTn0tMS4wLjQtZGVmYXVs dCBkZWZhdWx0DQoNCgluZXdpbml0ZCAiJHtGSUxFU0RJUn0iLyR7UE59LTIuMC4xNi1pbml0LmQg JHtQTn0NCgluZXdjb25mZCAiJHtGSUxFU0RJUn0iLyR7UE59LTIuMC4xNi1jb25mLmQgJHtQTn0N Cg0KCXN5c3RlbWRfZG91bml0ICIke0ZJTEVTRElSfSIvc3lzdGVtZC8ke1BOfS57c2VydmljZSxz b2NrZXR9DQoNCgljb25maWd1cmF0aW9uX2NyZWF0ZV9kb2MNCn0NCg0KcGtnX3Bvc3RpbnN0KCkg ew0KCWNvbmZpZ3VyYXRpb25fcHJpbnRfZWxvZw0KDQoJIyBmaWxlcy9zeXN0ZW1kL2FjcGlkLnNv Y2tldCAtPiBMaXN0ZW5TdHJlYW09L3J1bi9hY3BpZC5zb2NrZXQNCglta2RpciAtcCAiJHtST09U fSIvcnVuDQoNCglpZiAhIGdyZXAgLXFzICJedG1wZnMuKi9ydW4gIiAiJHtST09UfSIvcHJvYy9t b3VudHMgOyB0aGVuDQoJCWVjaG8NCgkJZXdhcm4gIllvdSBzaG91bGQgcmVib290IHRoZSBzeXN0 ZW0gbm93IHRvIGdldCAvcnVuIG1vdW50ZWQgd2l0aCB0bXBmcyEiDQoJZmkNCn0NCg== --=-NGEck0XclIpqi4Z9DHUt-- --=-6eWlz+iZWaR8NyO0DuN+ Content-Type: application/pgp-signature; name="signature.asc" Content-Description: This is a digitally signed message part -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.19 (GNU/Linux) iEYEABECAAYFAlDlgQ8ACgkQCaWpQKGI+9QkNgCffnB3qQrm9xo1zd17s7SGHBHu ZHkAn2ApDDgY2w+5nfXJtj9pJ4RDh4+L =sBIO -----END PGP SIGNATURE----- --=-6eWlz+iZWaR8NyO0DuN+--