aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorOleg Pykhalov <go.wigust@gmail.com>2020-02-22 17:54:25 +0300
committerOleg Pykhalov <go.wigust@gmail.com>2020-02-22 17:56:31 +0300
commit9a3971143854bf877c0739fc8fdf7b945a2e3935 (patch)
tree547d9c91308a8889c3496ee5fd753ad35ee2a344 /doc
parent582a79d3a9593d969757ec398c84ef8d63a94fb0 (diff)
downloadguix-9a3971143854bf877c0739fc8fdf7b945a2e3935.tar
guix-9a3971143854bf877c0739fc8fdf7b945a2e3935.tar.gz
etc: Add copyright.
* etc/copyright.el: New file. * doc/contributing.texi (The Perfect Setup): Document this.
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing.texi27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi
index a0d0925941..9d45becf86 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -274,6 +274,33 @@ trigger string @code{origin...}, which can be expanded further. The
@code{origin} snippet in turn may insert other trigger strings ending on
@code{...}, which also can be expanded further.
+@cindex insert or update copyright
+@cindex @code{M-x guix-copyright}
+@cindex @code{M-x copyright-update}
+Additionaly we provide insertion and automatic update of a copyright in
+@file{etc/copyright.el}. You may want to set your full name, mail, and
+load a file.
+
+@lisp
+(setq user-full-name "Alice Doe")
+(setq user-mail-address "alice@@mail.org")
+;; @r{Assuming the Guix checkout is in ~/src/guix.}
+(load-file "~/src/guix/etc/copyright.el")
+@end lisp
+
+To insert a copyright at the current line invoke @code{M-x guix-copyright}.
+
+To update a copyright you need to specify a @code{copyright-names-regexp}.
+
+@lisp
+(setq copyright-names-regexp
+ (format "%s <%s>" user-full-name user-mail-address))
+@end lisp
+
+You can check if your copyright is up to date by evaluating @code{M-x
+copyright-update}. If you want to do it automatically after each buffer
+save then add @code{(add-hook 'after-save-hook 'copyright-update)} in
+Emacs.
@node Packaging Guidelines
@section Packaging Guidelines