[137514] users/chunyang/helm-ls-svn.el

[chunyang at macports.org]

Revision: 137514
          https://trac.macports.org/changeset/137514
Author:   chunyang at macports.org
Date:     2015-06-13 06:51:02 -0700 (Sat, 13 Jun 2015)
Log Message:
-----------
users/chunyang: helm-ls-svn.el: Add documentation

Modified Paths:
--------------
    users/chunyang/helm-ls-svn.el/README.md
    users/chunyang/helm-ls-svn.el/helm-ls-svn.el

Modified: users/chunyang/helm-ls-svn.el/README.md
===================================================================
--- users/chunyang/helm-ls-svn.el/README.md	2015-06-13 13:23:15 UTC (rev 137513)
+++ users/chunyang/helm-ls-svn.el/README.md	2015-06-13 13:51:02 UTC (rev 137514)
@@ -1,3 +1,5 @@
 # helm-ls-svn
 
-helm extensions for listing files in svn project.
+a helm extension for listing files in svn project.
+
+Please see the Commentary in `helm-ls-svn.el` for more info.

Modified: users/chunyang/helm-ls-svn.el/helm-ls-svn.el
===================================================================
--- users/chunyang/helm-ls-svn.el/helm-ls-svn.el	2015-06-13 13:23:15 UTC (rev 137513)
+++ users/chunyang/helm-ls-svn.el/helm-ls-svn.el	2015-06-13 13:51:02 UTC (rev 137514)
@@ -29,6 +29,32 @@
 ;; `helm-ls-svn.el' is a helm extension for listing files in svn project.
 ;;
 ;;
+;; Installation
+;; ============
+;;
+;; To install, make sure this file is saved in a directory in your `load-path',
+;; and add the line:
+;;
+;;   (require 'helm-ls-svn)
+;;
+;; to your Emacs initialization file.
+;;
+;;
+;; Usage
+;; =====
+;;
+;; By calling helm-ls-svn-ls in any buffer that is a part of a svn repo, you
+;; will be presented with a corresponding helm buffer containing a list of all
+;; the buffers/files currently in that same repository,
+;;
+;;
+;; Reporting Bugs
+;; ==============
+;;
+;; Bug report, suggestion and patch are welcome. Please email me (see above to
+;; get my email address).
+;;
+;;
 ;; TODO
 ;; ====
 ;;
@@ -53,7 +79,10 @@
 
 (defgroup helm-ls-svn nil
   "Helm completion for svn repos."
-  :group 'helm)
+  :group 'helm
+  :link '(emacs-commentary-link :tag "commentary" "helm-ls-svn.el")
+  :link '(emacs-library-link :tag "lisp file" "helm-ls-svn.el")
+  :link '(url-link :tag "web page" "https://trac.macports.org/browser/users/chunyang/helm-ls-svn.el"))
 
 (defcustom helm-ls-svn-status-command 'vc-dir
   "Favorite svn-status command for emacs."
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20150613/e743e6e7/attachment.html>