summary refs log tree commit diff
path: root/pkgs/top-level/emacs-packages.nix
diff options
context:
space:
mode:
authorJan Malakhovski <oxij@oxij.org>2015-05-24 14:08:07 +0000
committerJan Malakhovski <oxij@oxij.org>2015-08-06 16:31:50 +0000
commit0031120921eef7baaa23340e22675a00d842a72e (patch)
treee4abeb00bb828102c8ad60d77da470411e0e16e6 /pkgs/top-level/emacs-packages.nix
parent56fbeb7a93ccec533316a685e2495d4178d3ae6c (diff)
downloadnixpkgs-0031120921eef7baaa23340e22675a00d842a72e.tar
nixpkgs-0031120921eef7baaa23340e22675a00d842a72e.tar.gz
nixpkgs-0031120921eef7baaa23340e22675a00d842a72e.tar.bz2
nixpkgs-0031120921eef7baaa23340e22675a00d842a72e.tar.lz
nixpkgs-0031120921eef7baaa23340e22675a00d842a72e.tar.xz
nixpkgs-0031120921eef7baaa23340e22675a00d842a72e.tar.zst
nixpkgs-0031120921eef7baaa23340e22675a00d842a72e.zip
emacs-packages: make the file header more informative
Diffstat (limited to 'pkgs/top-level/emacs-packages.nix')
-rw-r--r--pkgs/top-level/emacs-packages.nix38
1 files changed, 28 insertions, 10 deletions
diff --git a/pkgs/top-level/emacs-packages.nix b/pkgs/top-level/emacs-packages.nix
index a8cce92c1bc..444e086afb3 100644
--- a/pkgs/top-level/emacs-packages.nix
+++ b/pkgs/top-level/emacs-packages.nix
@@ -1,17 +1,35 @@
 # package.el-based emacs packages
+
+## FOR USERS
 #
-## add this at the start your init.el:
-# (require 'package)
-#
-# ;; optional. makes unpure packages archives unavailable
-# (setq package-archives nil)
-#
-# (add-to-list 'package-directory-list "/run/current-system/sw/share/emacs/site-lisp/elpa")
+# Recommended way: simply use `emacsWithPackages` from
+# `all-packages.nix` with the packages you want.
 #
-# ;; optional. use this if you install emacs packages to user profiles (with nix-env)
-# (add-to-list 'package-directory-list "~/.nix-profile/share/emacs/site-lisp/elpa")
+# Possible way: use `emacs` from `all-packages.nix`, install
+# everything to a system or user profile and then add this at the
+# start your `init.el`:
+/*
+  (require 'package)
+
+  ;; optional. makes unpure packages archives unavailable
+  (setq package-archives nil)
+
+  ;; optional. use this if you install emacs packages to the system profile
+  (add-to-list 'package-directory-list "/run/current-system/sw/share/emacs/site-lisp/elpa")
+
+  ;; optional. use this if you install emacs packages to user profiles (with nix-env)
+  (add-to-list 'package-directory-list "~/.nix-profile/share/emacs/site-lisp/elpa")
+
+  (package-initialize)
+*/
+
+## FOR CONTRIBUTORS
 #
-# (package-initialize)
+# When adding a new package here please note that
+# * lib.licenses are `with`ed on top of the file here
+# * both trivialBuild and melpaBuild will automatically derive a
+#   `meta` with `platforms` and `homepage` set to something you are
+#   unlikely to want to override for most packages
 
 { overrides