From mboxrd@z Thu Jan 1 00:00:00 1970 From: David Holm Subject: [PATCH v1 1/4] contrib/lisp/org-annotate-file.el improvements Date: Sat, 15 Mar 2014 19:15:55 +0100 Message-ID: Mime-Version: 1.0 Content-Type: multipart/mixed; boundary=001a11c13d64663c4704f4a92d41 Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:43159) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WOt7l-0002tp-8U for emacs-orgmode@gnu.org; Sat, 15 Mar 2014 14:15:58 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WOt7k-00088y-2q for emacs-orgmode@gnu.org; Sat, 15 Mar 2014 14:15:57 -0400 Received: from mail-qa0-x235.google.com ([2607:f8b0:400d:c00::235]:39437) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WOt7j-00088q-T7 for emacs-orgmode@gnu.org; Sat, 15 Mar 2014 14:15:55 -0400 Received: by mail-qa0-f53.google.com with SMTP id w8so3852596qac.12 for ; Sat, 15 Mar 2014 11:15:55 -0700 (PDT) List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: emacs-orgmode@gnu.org --001a11c13d64663c4704f4a92d41 Content-Type: multipart/alternative; boundary=001a11c13d64663c4304f4a92d3f --001a11c13d64663c4304f4a92d3f Content-Type: text/plain; charset=ISO-8859-1 Hi All, I was looking for a way to annotate code in Emacs for code reviews and found a post on Stack Overflow recommending org-annotate-file [1]. This was pretty close to what I was looking for but with two exceptions, * I wanted to be able to store the annotations in different files depending on the project and * I wanted the write my comments in a popup window. In order to accomplish this I have modified org-annotate-file so that the storage file is passed as a parameter to `org-annotate-file-show-section` and only `org-annotate-file` directly use the variable `org-annotate-file-storage-file`. I also changed `org-annotate-file-show-section` to return the annotation buffer rather than switching to it. `org-annotate-file` will just pass it to `switch-to-buffer` but in my personal configuration I instead hand it off to popwin so that it is shown as a popup: (popwin:display-buffer-1 (org-annotate-file-show-section storage-file) :default-config-keywords '(:position :bottom)) This first patch just fixes some of the docstrings in order to satisfy Flycheck. Best regards, David Holm [1]: http://stackoverflow.com/questions/8148842/code-review-mode-package-for-emacs-with-good-reporting-function --001a11c13d64663c4304f4a92d3f Content-Type: text/html; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable
Hi All,
I was looking for a way to annotate code in Em= acs for code reviews and found a post on Stack Overflow recommending org-an= notate-file [1]. =A0This was pretty close to what I was looking for but wit= h two exceptions,
=A0* I wanted to be able to store the annotations in different files d= epending on the project and
=A0* I wanted the write my comments i= n a popup window.

In order to accomplish this I ha= ve modified org-annotate-file so that the storage file is passed as a param= eter to `org-annotate-file-show-section` and only `org-annotate-file` direc= tly use the variable `org-annotate-file-storage-file`. =A0I also changed `o= rg-annotate-file-show-section` to return the annotation buffer rather than = switching to it. =A0`org-annotate-file` will just pass it to `switch-to-buf= fer` but in my personal configuration I instead hand it off to popwin so th= at it is shown as a popup:

=A0 =A0(popwin:display-buffer-1 (org-annotate-file= -show-section storage-file)
=A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 =A0 = =A0 =A0 =A0 =A0 =A0 =A0:default-config-keywords '(:position :bottom))

This first patch just fixes some of the docst= rings in order to satisfy Flycheck.

Best regards,
David Holm

=
--001a11c13d64663c4304f4a92d3f-- --001a11c13d64663c4704f4a92d41 Content-Type: application/octet-stream; name="0001-Fix-issues-detected-by-CheckDoc.patch" Content-Disposition: attachment; filename="0001-Fix-issues-detected-by-CheckDoc.patch" Content-Transfer-Encoding: base64 X-Attachment-Id: f_hst7tyiz0 RnJvbSA5NGM4OGMzYmZlNTIyZGI2NTJmMmM3ZTVhNjg3Njg1MTBjMTZkM2QxIE1vbiBTZXAgMTcg MDA6MDA6MDAgMjAwMQpGcm9tOiBEYXZpZCBIb2xtIDxkaG9sbXN0ZXJAZ21haWwuY29tPgpEYXRl OiBTYXQsIDE1IE1hciAyMDE0IDE2OjUwOjA0ICswMTAwClN1YmplY3Q6IFtQQVRDSCAxLzRdIEZp eCBpc3N1ZXMgZGV0ZWN0ZWQgYnkgQ2hlY2tEb2MKCiogbGlzcC9jb250cmliL29yZy1hbm5vdGF0 ZS1maWxlLmVsOiBGaXhlcyB0aGUgc3R5bGUgb2YgdGhlCmRvY3VtZW50YXRpb24gdG8gbWFrZSBF bWFjcyBDaGVja0RvYyBoYXBweS4KClRJTllDSEFOR0UKLS0tCiBjb250cmliL2xpc3Avb3JnLWFu bm90YXRlLWZpbGUuZWwgfCAzNSArKysrKysrKysrKysrKysrKysrKy0tLS0tLS0tLS0tLS0tLQog MSBmaWxlIGNoYW5nZWQsIDIwIGluc2VydGlvbnMoKyksIDE1IGRlbGV0aW9ucygtKQoKZGlmZiAt LWdpdCBhL2NvbnRyaWIvbGlzcC9vcmctYW5ub3RhdGUtZmlsZS5lbCBiL2NvbnRyaWIvbGlzcC9v cmctYW5ub3RhdGUtZmlsZS5lbAppbmRleCAwNWNjNDVmLi4wZDQxNTc0IDEwMDY0NAotLS0gYS9j b250cmliL2xpc3Avb3JnLWFubm90YXRlLWZpbGUuZWwKKysrIGIvY29udHJpYi9saXNwL29yZy1h bm5vdGF0ZS1maWxlLmVsCkBAIC0yNSw3ICsyNSw3IEBACiA7OzsgQ29tbWVudGFyeToKIAogOzsg VGhpcyBpcyB5ZXQgYW5vdGhlciBpbXBsZW1lbnRhdGlvbiB0byBhbGxvdyB0aGUgYW5ub3RhdGlv biBvZiBhCi07OyBmaWxlIHdpdGhvdXQgbW9kaWZpY2F0aW9uIG9mIHRoZSBmaWxlIGl0c2VsZi4g VGhlIGFubm90YXRpb24gaXMgaW4KKzs7IGZpbGUgd2l0aG91dCBtb2RpZmljYXRpb24gb2YgdGhl IGZpbGUgaXRzZWxmLiAgVGhlIGFubm90YXRpb24gaXMgaW4KIDs7IG9yZyBzeW50YXggc28geW91 IGNhbiB1c2UgYWxsIG9mIHRoZSBvcmcgZmVhdHVyZXMgeW91IGFyZSB1c2VkIHRvLgogCiA7OyBU byB1c2UgeW91IG1pZ2h0IHB1dCB0aGUgZm9sbG93aW5nIGluIHlvdXIgLmVtYWNzOgpAQCAtNDcs MzAgKzQ3LDMxIEBACiA7OyBhbmQgbmV4dCB0aW1lIHlvdSBoaXQgQy1jIEMtbCB5b3Ugd2lsbCBo aXQgdGhvc2Ugbm90ZXMgYWdhaW4uCiA7OwogOzsgVG8gcHV0IGEgc3ViaGVhZGluZyB3aXRoIGEg dGV4dCBzZWFyY2ggZm9yIHRoZSBjdXJyZW50IGxpbmUgc2V0Ci07OyBgb3JnLWFubm90YXRlLWZp bGUtYWRkLXNlYXJjaGAgdG8gbm9uLW5pbCB2YWx1ZS4gVGhlbiB3aGVuIHlvdSBoaXQKKzs7IGBv cmctYW5ub3RhdGUtZmlsZS1hZGQtc2VhcmNoYCB0byBub24tbmlsIHZhbHVlLiAgVGhlbiB3aGVu IHlvdSBoaXQKIDs7IEMtYyBDLWwgKG9uIHRoZSBhYm92ZSBsaW5lIGZvciBleGFtcGxlKSB5b3Ug d2lsbCBnZXQ6CiAKIDs7ICogfi9vcmctYW5ub3RhdGUtZmlsZS5lbAotOzsgKiogYG9yZy1hbm5v dGF0ZS1maWxlLWFkZC1zZWFyY2hgIHRvIG5vbi1uaWwgdmFsdWUuIFRoZW4gd2hlLi4uCis7OyAq KiBgb3JnLWFubm90YXRlLWZpbGUtYWRkLXNlYXJjaGAgdG8gbm9uLW5pbCB2YWx1ZS4gIFRoZW4g d2hlLi4uCiAKIDs7IE5vdGUgdGhhdCBib3RoIG9mIHRoZSBhYm92ZSB3aWxsIGJlIGxpbmtzLgog Cis7OzsgQ29kZToKKwogKHJlcXVpcmUgJ29yZykKIAogKGRlZnZhciBvcmctYW5ub3RhdGUtZmls ZS1zdG9yYWdlLWZpbGUgIn4vLm9yZy1hbm5vdGF0ZS1maWxlLm9yZyIKICAgIkZpbGUgaW4gd2hp Y2ggdG8ga2VlcCBhbm5vdGF0aW9ucy4iKQogCiAoZGVmdmFyIG9yZy1hbm5vdGF0ZS1maWxlLWFk ZC1zZWFyY2ggbmlsCi0gICJJZiBub24tbmlsIHRoZW4gYWRkIGEgbGluayBhcyBhIHNlY29uZCBs ZXZlbCB0byB0aGUgYWN0dWFsCi1sb2NhdGlvbiBpbiB0aGUgZmlsZSIpCisgICJJZiBub24tbmls LCBhZGQgYSBsaW5rIGFzIGEgc2Vjb25kIGxldmVsIHRvIHRoZSBhY3R1YWwgZmlsZSBsb2NhdGlv bi4iKQogCiAoZGVmdmFyIG9yZy1hbm5vdGF0ZS1maWxlLWFsd2F5cy1vcGVuIHQKLSAgIm5vbi1u aWwgbWVhbnMgYWx3YXlzIGV4cGFuZCB0aGUgZnVsbCB0cmVlIHdoZW4geW91IHZpc2l0Ci1gb3Jn LWFubm90YXRlLWZpbGUtc3RvcmFnZS1maWxlJy4iKQorICAiSWYgbm9uLW5pbCwgYWx3YXlzIGV4 cGFuZCB0aGUgZnVsbCB0cmVlIHdoZW4gdmlzaXRpbmcgdGhlIGFubm90YXRpb24gZmlsZS4iKQog Ci0oZGVmdW4gb3JnLWFubm90YXRlLWZpbGUtZWxpcHNpZnktZGVzYyAoc3RyaW5nICZvcHRpb25h bCBhZnRlcikKLSAgIlN0cmlwIHN0YXJ0aW5nIGFuZCBlbmRpbmcgd2hpdGVzcGFjZSBhbmQgcmVw bGFjZSBhbnkgY2hhcnMKLXRoYXQgYXBwZWFyIGFmdGVyIHRoZSB2YWx1ZSBpbiBgYWZ0ZXInIHdp dGggJy4uLiciCisoZGVmdW4gb3JnLWFubm90YXRlLWZpbGUtZWxsaXBzaWZ5LWRlc2MgKHN0cmlu ZyAmb3B0aW9uYWwgYWZ0ZXIpCisgICJSZXR1cm4gc2hvcnRlbmVkIFNUUklORyB3aXRoIGFwcGVu ZGVkIGVsbGlwc2lzLgorVHJpbSB3aGl0ZXNwYWNlIGF0IGJlZ2lubmluZyBhbmQgZW5kIG9mIFNU UklORyBhbmQgcmVwbGFjZSBhbnkKKyAgY2hhcmFjdGVycyB0aGF0IGFwcGVhciBhZnRlciB0aGUg b2NjdXJyZW5jZSBvZiBBRlRFUiB3aXRoICcuLi4nIgogICAobGV0KiAoKGFmdGVyIChudW1iZXIt dG8tc3RyaW5nIChvciBhZnRlciAzMCkpKQogICAgICAgICAgKHJlcGxhY2UtbWFwIChsaXN0IChj b25zICJeWyBcdF0qIiAiIikKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAoY29ucyAiWyBc dF0qJCIgIiIpCkBAIC04MywyMSArODQsMjMgQEAgdGhhdCBhcHBlYXIgYWZ0ZXIgdGhlIHZhbHVl IGluIGBhZnRlcicgd2l0aCAnLi4uJyIKICAgICBzdHJpbmcpKQogCiAoZGVmdW4gb3JnLWFubm90 YXRlLWZpbGUgKCkKLSAgIlB1dCBhIHNlY3Rpb24gZm9yIHRoZSBjdXJyZW50IGZpbGUgaW50byB5 b3VyIGFubm90YXRpb24gZmlsZSIKKyAgIlB1dCBhIHNlY3Rpb24gZm9yIHRoZSBjdXJyZW50IGZp bGUgaW50byB5b3VyIGFubm90YXRpb24gZmlsZS4iCiAgIChpbnRlcmFjdGl2ZSkKICAgKHVubGVz cyAoYnVmZmVyLWZpbGUtbmFtZSkKLSAgICAoZXJyb3IgIlRoaXMgYnVmZmVyIGhhcyBubyBhc3Nv Y2lhdGVkIGZpbGUiKSkKKyAgICAoZXJyb3IgIlRoaXMgYnVmZmVyIGhhcyBubyBhc3NvY2lhdGVk IGZpbGUhIikpCiAgIChvcmctYW5ub3RhdGUtZmlsZS1zaG93LXNlY3Rpb24pKQogCiAoZGVmdW4g b3JnLWFubm90YXRlLWZpbGUtc2hvdy1zZWN0aW9uICgmb3B0aW9uYWwgYnVmZmVyKQotICAiVmlz aXQgdGhlIGJ1ZmZlciBuYW1lZCBgb3JnLWFubm90YXRlLWZpbGUtc3RvcmFnZS1maWxlJyBhbmQK LXNob3cgdGhlIHJlbGV2YW50IHNlY3Rpb24iCisgICJWaXNpdCB0aGUgYnVmZmVyIG5hbWVkIGBv cmctYW5ub3RhdGUtZmlsZS1zdG9yYWdlLWZpbGUnLgorVGhlIGN1cnNvciB3aWxsIGJlIHBsYWNl ZCBhdCB0aGUgcmVsZXZhbnQgc2VjdGlvbi4gIElmIEJVRkZFUiBpcworICBzcGVjaWZpZWQgdGhl IGFubm90YXRpb24gd2lsbCBiZSByZWZlcmVuY2luZyBpdCwgb3RoZXJ3aXNlIHRoZQorICBjdXJy ZW50IGJ1ZmZlciBpcyB1c2VkLiIKICAgKGxldCogKChmaWxlbmFtZSAoYWJicmV2aWF0ZS1maWxl LW5hbWUgKG9yIGJ1ZmZlciAoYnVmZmVyLWZpbGUtbmFtZSkpKSkKICAgICAgICAgIChsaW5lIChi dWZmZXItc3Vic3RyaW5nLW5vLXByb3BlcnRpZXMgKHBvaW50LWF0LWJvbCkgKHBvaW50LWF0LWVv bCkpKQogICAgICAgICAgKGxpbmsgKG9yZy1tYWtlLWxpbmstc3RyaW5nIChjb25jYXQgImZpbGU6 IiBmaWxlbmFtZSkgZmlsZW5hbWUpKQogICAgICAgICAgKHNlYXJjaC1saW5rIChvcmctbWFrZS1s aW5rLXN0cmluZwogICAgICAgICAgICAgICAgICAgICAgICAoY29uY2F0ICJmaWxlOiIgZmlsZW5h bWUgIjo6IiBsaW5lKQotICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIChvcmctYW5ub3Rh dGUtZmlsZS1lbGlwc2lmeS1kZXNjIGxpbmUpKSkpCisgICAgICAgICAgICAgICAgICAgICAgICAg ICAgICAgKG9yZy1hbm5vdGF0ZS1maWxlLWVsbGlwc2lmeS1kZXNjIGxpbmUpKSkpCiAgICAgKHdp dGgtY3VycmVudC1idWZmZXIgKGZpbmQtZmlsZSBvcmctYW5ub3RhdGUtZmlsZS1zdG9yYWdlLWZp bGUpCiAgICAgICAodW5sZXNzIChlcSBtYWpvci1tb2RlICdvcmctbW9kZSkKICAgICAgICAgKG9y Zy1tb2RlKSkKQEAgLTExNywxMSArMTIwLDEzIEBAIHNob3cgdGhlIHJlbGV2YW50IHNlY3Rpb24i CiAgICAgICAgICAgKG9yZy1hbm5vdGF0ZS1maWxlLWFkZC1zZWNvbmQtbGV2ZWwgc2VhcmNoLWxp bmspKSkpKSkKIAogKGRlZnVuIG9yZy1hbm5vdGF0ZS1maWxlLWFkZC11cHBlci1sZXZlbCAobGlu aykKKyAgIkFkZCBhbmQgbGluayBoZWFkaW5nIHRvIExJTksuIgogICAoZ290by1jaGFyIChwb2lu dC1taW4pKQogICAoY2FsbC1pbnRlcmFjdGl2ZWx5ICdvcmctaW5zZXJ0LWhlYWRpbmcpCiAgIChp bnNlcnQgbGluaykpCiAKIChkZWZ1biBvcmctYW5ub3RhdGUtZmlsZS1hZGQtc2Vjb25kLWxldmVs IChsaW5rKQorICAiQWRkIGFuZCBsaW5rIHN1YmhlYWRpbmcgdG8gTElOSy4iCiAgIChnb3RvLWNo YXIgKHBvaW50LWF0LWVvbCkpCiAgIChjYWxsLWludGVyYWN0aXZlbHkgJ29yZy1pbnNlcnQtc3Vi aGVhZGluZykKICAgKGluc2VydCBsaW5rKSkKLS0gCjEuOS4wCgo= --001a11c13d64663c4704f4a92d41--