diff --git a/core/core-dotspacemacs.el b/core/core-dotspacemacs.el index 51bcdf0da410..f11153ff10d3 100644 --- a/core/core-dotspacemacs.el +++ b/core/core-dotspacemacs.el @@ -65,7 +65,7 @@ Paths must have a trailing slash (ie. `~/.mycontribs/')") "List of additional packages that will be installed wihout being wrapped in a layer. If you need some configuration for these packages then consider to create a layer, you can also put the -configuration in `dotspacemacs/config'.") +configuration in `dotspacemacs/user-config'.") (defvar dotspacemacs-editing-style 'vim "Either `vim' or `emacs'. Evil is always enabled but if the variable @@ -227,7 +227,7 @@ Possible values are: `recents' `bookmarks' `projects'.") "Synchronize declared layers in dotfile with spacemacs. Called with `C-u' skips `dotspacemacs/user-config'. -Called with `C-u C-u' skips `dotspacemacs/user-config' and preleminary tests." +Called with `C-u C-u' skips `dotspacemacs/user-config' _and_ preleminary tests." (interactive "P") (when (file-exists-p dotspacemacs-filepath) (with-current-buffer (find-file-noselect dotspacemacs-filepath) @@ -242,7 +242,7 @@ Called with `C-u C-u' skips `dotspacemacs/user-config' and preleminary tests." "Calling dotfile init...") (configuration-layer/sync) (if (member arg '(4 16)) - (message (concat "Done (`dotspacemacs/config'function has " + (message (concat "Done (`dotspacemacs/user-config' function has " "been skipped).")) ;; TODO remove support for dotspacemacs/config in 0.105 (if (fboundp 'dotspacemacs/user-config) diff --git a/doc/DOCUMENTATION.org b/doc/DOCUMENTATION.org index 9583e6917886..b29760091312 100644 --- a/doc/DOCUMENTATION.org +++ b/doc/DOCUMENTATION.org @@ -1133,7 +1133,7 @@ This sequence can be customized in your =~/.spacemacs=. Example to set it to ~jj~: #+begin_src emacs-lisp - (defun dotspacemacs/init () + (defun dotspacemacs/user-config () (setq-default evil-escape-key-sequence "jj")) #+end_src diff --git a/doc/HOWTOs.org b/doc/HOWTOs.org index 6f76c45df9c9..ed104357a5c9 100644 --- a/doc/HOWTOs.org +++ b/doc/HOWTOs.org @@ -2,11 +2,11 @@ ** Table of Contents :TOC@4: - [[#compilation-of-quick-how-tos-for-spacemacs][Compilation of quick HOW-TOs for Spacemacs]] - - [[#disable-a-package-completely][Disable a package completely]] - - [[#disable-a-package-only-for-a-specific-major-mode][Disable a package only for a specific major-mode]] - - [[#disable-company-for-a-specific-major-mode][Disable company for a specific major-mode]] - - [[#change-special-buffer-rules][Change special buffer rules]] - - [[#enable-navigation-by-visual-lines][Enable navigation by visual lines]] + - [[#disable-a-package-completely][Disable a package completely]] + - [[#disable-a-package-only-for-a-specific-major-mode][Disable a package only for a specific major-mode]] + - [[#disable-company-for-a-specific-major-mode][Disable company for a specific major-mode]] + - [[#change-special-buffer-rules][Change special buffer rules]] + - [[#enable-navigation-by-visual-lines][Enable navigation by visual lines]] ** Disable a package completely To completely disable a package and effectively uninstalling it even if @@ -21,7 +21,7 @@ name to it: ** Disable a package only for a specific major-mode This is done by removing the hook added by Spacemacs. For example to remove =flycheck= support in python buffers, look for the function -=dotspacemacs/config= in your dotfile and add the following code: +=dotspacemacs/user-config= in your dotfile and add the following code: #+begin_src emacs-lisp (remove-hook 'python-mode-hook 'flycheck-mode) @@ -33,7 +33,7 @@ remove =flycheck= support in python buffers, look for the function ** Disable company for a specific major-mode It may be handy to disable =company= for a given mode if you plan on configuring =auto-complete= instead. On easy way to do it is to use the -macro =spacemacs|disable-company= in the function =dotspacemacs/config= +macro =spacemacs|disable-company= in the function =dotspacemacs/user-config= of your dotfile. The following snippet disables company for =python-mode=: diff --git a/doc/VIMUSERS.org b/doc/VIMUSERS.org index e2ba75c8197a..03fa9323e30f 100644 --- a/doc/VIMUSERS.org +++ b/doc/VIMUSERS.org @@ -190,14 +190,15 @@ If you are reading this, you likely want to choose the vim style. A =.spacemacs= file will be created with the appropriate style selected. Most trivial configuration will go in this file. -There are three top-level function in the file: =dotspacemacs/layers=, -=dotspacemacs/init=, and =dotspacemacs/config=. The =dotspacemacs/layers= -function exist only to enable and disable layers and packages. The -=dotspacemacs/init= function is run before anything else during startup and -contains many Spacemacs settings. You will almost never need to touch this -function except to change default Spacemacs settings. The =dotspacemacs/config= -function is the one you will use the most. This is where you define any user -configuration. +There are four top-level function in the file: =dotspacemacs/layers=, +=dotspacemacs/init=, =dotspacemacs/user-init= and =dotspacemacs/user-config=. +The =dotspacemacs/layers= function exist only to enable and disable layers and +packages. The =dotspacemacs/init= function is run before anything else during +startup and contains Spacemacs settings. You will never need to touch this +function except to change default Spacemacs settings. +The =dotspacemacs/user-init= function is also run before anything else and +contains user specific configuration. The =dotspacemacs/user-config= function +is the one you will use the most. This is where you define any user configuration. | Keybinding | Function | |-------------+--------------------------------------------------------------------------| @@ -412,22 +413,21 @@ the list and it will be uninstalled when you restart. ** Common tweaks This section is for things many will want to change. All of these settings go in -the =dotspacemacs/config= function in your =.spacemacs= unless otherwise noted. +the =dotspacemacs/user-config= function in your =.spacemacs= unless otherwise noted. *** Changing the escape key Spacemacs uses =[[https://github.com/syl20bnr/evil-escape][evil-escape]]= to allow escaping from many =major-modes= with one keybinding. You can customize -the variable in your =dotspacemacs/init= like this: +the variable in your =dotspacemacs/user-config= like this: #+begin_src emacs-lisp - (defun dotspacemacs/init () + (defun dotspacemacs/user-config () ;; ... ;; Set escape keybinding to "jk" (setq-default evil-escape-key-sequence "jk")) #+end_src -This is one of the few variables that must be set in =dotspacemacs/init=. More -documentation is found in the =evil-escape= [[https://github.com/syl20bnr/evil-escape/blob/master/README.md][README]]. +More documentation is found in the =evil-escape= [[https://github.com/syl20bnr/evil-escape/blob/master/README.md][README]]. *** Changing the colorscheme The =.spacemacs= file contains the =dotspacemacs-themes= variable in the @@ -460,11 +460,11 @@ you can [[#uninstalling-a-package][uninstall]] the =evil-search-highlight-persis *** Sessions Spacemacs does not automatically restore your windows and buffers when you reopen it. If you use vim sessions regularly you may want to add -=(desktop-save-mode t)= to you =dotspacemacs/config= in your =.spacemacs= to get -this functionality. You will then be able to load the saved session using ~SPC : -desktop-read~. The location of the desktop file can be set with the variable -=desktop-dirname=. To automatically load a session, add =(desktop-read)= to your -=.spacemacs=. +=(desktop-save-mode t)= to your =dotspacemacs/user-config= in your =.spacemacs= +to get this functionality. You will then be able to load the saved session +using ~SPC : desktop-read~. The location of the desktop file can be set with +the variable =desktop-dirname=. To automatically load a session, +add =(desktop-read)= to your =.spacemacs=. *** Navigating using visual lines Spacemacs uses the vim default of navigating by actual lines, even if they are diff --git a/layers/+irc/rcirc/README.org b/layers/+irc/rcirc/README.org index 4149aadae8b5..a5ef4250d7cc 100644 --- a/layers/+irc/rcirc/README.org +++ b/layers/+irc/rcirc/README.org @@ -6,16 +6,16 @@ - [[#description][Description]] - [[#features][Features]] - [[#install][Install]] - - [[#layer][Layer]] - - [[#configuration][Configuration]] - - [[#storing-the-credentials-in-your-dotfile][Storing the credentials in your dotfile]] - - [[#example][Example:]] - - [[#storing-the-credentials-in-your-dropbox][Storing the credentials in your Dropbox]] - - [[#example][Example:]] - - [[#storing-the-credentials-in-authinfo][Storing the credentials in authinfo]] - - [[#connecting-behind-a-znc-bouncer-and-storing-the-credentials-in-authinfo][Connecting behind a ZNC bouncer and storing the credentials in authinfo]] - - [[#disclaimer][Disclaimer]] - - [[#note][Note]] + - [[#layer][Layer]] + - [[#configuration][Configuration]] + - [[#storing-the-credentials-in-your-dotfile][Storing the credentials in your dotfile]] + - [[#example][Example:]] + - [[#storing-the-credentials-in-your-dropbox][Storing the credentials in your Dropbox]] + - [[#example][Example:]] + - [[#storing-the-credentials-in-authinfo][Storing the credentials in authinfo]] + - [[#connecting-behind-a-znc-bouncer-and-storing-the-credentials-in-authinfo][Connecting behind a ZNC bouncer and storing the credentials in authinfo]] + - [[#disclaimer][Disclaimer]] + - [[#note][Note]] - [[#key-bindings][Key Bindings]] - [[#rcirc-documentation][Rcirc documentation]] @@ -57,7 +57,7 @@ There are several ways to configure rcirc supported by the layer: *** Storing the credentials in your dotfile You can store your servers configuration along with your credentials in the -=dotspacemacs/config= of your dotfile. +=dotspacemacs/user-config= of your dotfile. *Important:* This method is the less secured and it is not recommended since your dotfile is often stored in a public repository and is not crypted. This @@ -115,7 +115,7 @@ rcirc. #+END_SRC 3) At last you need to provide your servers configuration in the - =dotspacemacs/config= function of your dotfile: + =dotspacemacs/user-config= function of your dotfile: #+BEGIN_SRC emacs-lisp (setq rcirc-server-alist @@ -162,7 +162,7 @@ For now authinfo is mandatory to use the ZNC configuration. retrieve the credentials for the ZNC configuration. 3) Then setup your servers configuration using subdomains in the - =dotspacemacs/config= function of your dotfile. The =:auth= keyword arguments + =dotspacemacs/user-config= function of your dotfile. The =:auth= keyword arguments will be replaced by the credentials stored in your =~/.authinfo.gpg=. #+BEGIN_SRC emacs-lisp diff --git a/layers/+lang/c-c++/README.org b/layers/+lang/c-c++/README.org index a6f8d0fd8417..c9ef2000fa6f 100644 --- a/layers/+lang/c-c++/README.org +++ b/layers/+lang/c-c++/README.org @@ -7,11 +7,11 @@ - [[#description][Description]] - [[#features][Features]] - [[#install][Install]] - - [[#layer][Layer]] - - [[#default-mode-for-header-files][Default mode for header files]] - - [[#enable-clang-support][Enable Clang support]] - - [[#clang-format][clang-format]] - - [[#company-clang-and-flycheck][Company-clang and flycheck]] + - [[#layer][Layer]] + - [[#default-mode-for-header-files][Default mode for header files]] + - [[#enable-clang-support][Enable Clang support]] + - [[#clang-format][clang-format]] + - [[#company-clang-and-flycheck][Company-clang and flycheck]] - [[#key-bindings][Key Bindings]] * Description @@ -76,7 +76,7 @@ located in the same directory as the file being edited, or in any of its parent directories (otherwise a default style will be used). You can add snippets similar to the following to bind clang-format to either a -particular mode or all modes in your =dotspacemacs/config= (within your +particular mode or all modes in your =dotspacemacs/user-config= (within your =~/.spacemacs=): #+BEGIN_SRC emacs-lisp diff --git a/layers/+lang/clojure/README.org b/layers/+lang/clojure/README.org index 18b9c2473090..f173ba73f4f9 100644 --- a/layers/+lang/clojure/README.org +++ b/layers/+lang/clojure/README.org @@ -18,6 +18,7 @@ - [[#goto][Goto]] - [[#repl][REPL]] - [[#tests][Tests]] + - [[#toggles][Toggles]] - [[#debugging][Debugging]] - [[#refactoring][Refactoring]] - [[#reformatting][Reformatting]] @@ -51,8 +52,8 @@ To use this contribution add it to your =~/.spacemacs= Pretty symbols for anonymous functions, set literals and partial, like =(λ [a] (+ a 5))=, =ƒ(+ % 5)=, =∈{2 4 6}= and =Ƥ=. -To enable this feature, add the following snippet to the dotspacemacs/config -section of your =~/.spacemacs= file: +To enable this feature, add the following snippet to the +=dotspacemacs/user-config= section of your =~/.spacemacs= file: #+BEGIN_SRC emacs-lisp (setq clojure-enable-fancify-symbols t) diff --git a/layers/+lang/common-lisp/README.org b/layers/+lang/common-lisp/README.org index 80ba52fa0ecf..009faac8ef81 100644 --- a/layers/+lang/common-lisp/README.org +++ b/layers/+lang/common-lisp/README.org @@ -6,12 +6,12 @@ - [[#description][Description]] - [[#install][Install]] - [[#key-bindings][Key Bindings]] - - [[#help][Help]] - - [[#evaluation][Evaluation]] - - [[#repl][REPL]] - - [[#compile][Compile]] - - [[#navigation][Navigation]] - - [[#macroexpansion][Macroexpansion]] + - [[#help][Help]] + - [[#evaluation][Evaluation]] + - [[#repl][REPL]] + - [[#compile][Compile]] + - [[#navigation][Navigation]] + - [[#macroexpansion][Macroexpansion]] * Description @@ -34,7 +34,7 @@ This layer defaults to using [[http://www.sbcl.org/][sbcl]]. If you want to use of Common Lisp, you can specify it in your =~/.spacemacs= #+BEGIN_SRC emacs-lisp - (defun dotspacemacs/config () + (defun dotspacemacs/user-config () (setq inferior-lisp-program "/path/to/your/lisp")) #+END_SRC diff --git a/layers/+lang/haskell/README.org b/layers/+lang/haskell/README.org index 8110eb38d598..6fa29634d3df 100644 --- a/layers/+lang/haskell/README.org +++ b/layers/+lang/haskell/README.org @@ -4,22 +4,22 @@ * Table of Contents :TOC@4: - [[#description][Description]] - - [[#features][Features:]] + - [[#features][Features:]] - [[#install][Install]] - - [[#layer][Layer]] - - [[#cabal-packages][Cabal packages]] - - [[#os-x][OS X]] - - [[#optional-extras][Optional extras]] - - [[#ghc-mod-support][ghc-mod support]] - - [[#ghci-ng-support][GHCi-ng support]] - - [[#structured-haskell-mode][structured-haskell-mode]] - - [[#hindent][hindent]] + - [[#layer][Layer]] + - [[#cabal-packages][Cabal packages]] + - [[#os-x][OS X]] + - [[#optional-extras][Optional extras]] + - [[#ghc-mod-support][ghc-mod support]] + - [[#ghci-ng-support][GHCi-ng support]] + - [[#structured-haskell-mode][structured-haskell-mode]] + - [[#hindent][hindent]] - [[#key-bindings][Key bindings]] - - [[#documentation][Documentation]] - - [[#debug][Debug]] - - [[#repl][REPL]] - - [[#cabal-commands][Cabal commands]] - - [[#cabal-files][Cabal files]] + - [[#documentation][Documentation]] + - [[#debug][Debug]] + - [[#repl][REPL]] + - [[#cabal-commands][Cabal commands]] + - [[#cabal-files][Cabal files]] * Description This layer adds support for the [[https://www.haskell.org/][Haskell]] language. @@ -62,13 +62,13 @@ pick up shell PATH. #+END_SRC _Alternatively_, you can add it to the Emacs =exec-path= variable in the -=dotspacemacs/init= function of your =.spacemacs= file: +=dotspacemacs/user-init= function of your =.spacemacs= file: #+BEGIN_SRC emacs-lisp (add-to-list 'exec-path "~/.cabal/bin/") #+END_SRC -*Note:* it is important to add the path in the =dotspacemacs/init= function, +*Note:* it is important to add the path in the =dotspacemacs/user-init= function, so that the path is added before any layers is loaded. ** OS X diff --git a/layers/+lang/java/README.org b/layers/+lang/java/README.org index 6d0b648563c9..254f222291cc 100644 --- a/layers/+lang/java/README.org +++ b/layers/+lang/java/README.org @@ -5,21 +5,21 @@ * Table of Contents :TOC@4: - [[#description][Description]] - [[#layer-installation][Layer Installation]] - - [[#layer][Layer]] - - [[#eclim][Eclim]] - - [[#installation][Installation]] - - [[#usage][Usage]] + - [[#layer][Layer]] + - [[#eclim][Eclim]] + - [[#installation][Installation]] + - [[#usage][Usage]] - [[#key-bindings][Key bindings]] - - [[#java-mode][Java-mode]] - - [[#project-management][Project management]] - - [[#maven][Maven]] - - [[#goto][Goto]] - - [[#refactoring][Refactoring]] - - [[#documentation-find][Documentation, Find]] - - [[#problems][Problems]] - - [[#tests][Tests]] - - [[#problems-buffer][Problems buffer]] - - [[#projects-buffer][Projects buffer]] + - [[#java-mode][Java-mode]] + - [[#project-management][Project management]] + - [[#maven][Maven]] + - [[#goto][Goto]] + - [[#refactoring][Refactoring]] + - [[#documentation-find][Documentation, Find]] + - [[#problems][Problems]] + - [[#tests][Tests]] + - [[#problems-buffer][Problems buffer]] + - [[#projects-buffer][Projects buffer]] * Description This layer adds support for the Java language using the [[http://eclim.org][Eclim]] client/server. @@ -39,7 +39,7 @@ searching, code validation, and many more. *** Installation For installation check the [[http://eclim.org/install.html#download][official page]]. -Then set the =Eclipse= and =Eclim= paths in =dotspacemacs/config=, +Then set the =Eclipse= and =Eclim= paths in =dotspacemacs/user-config=, for instance: #+BEGIN_SRC elisp diff --git a/layers/+lang/latex/README.org b/layers/+lang/latex/README.org index 92ed31305178..183d4f214a9a 100644 --- a/layers/+lang/latex/README.org +++ b/layers/+lang/latex/README.org @@ -4,15 +4,15 @@ * Table of Contents :TOC@4: - [[#description][Description]] - - [[#features][Features]] + - [[#features][Features]] - [[#install][Install]] - - [[#layer][Layer]] - - [[#auto-completion][Auto-completion]] - - [[#previewing][Previewing]] - - [[#build-command][Build command]] - - [[#auto-fill][Auto-fill]] + - [[#layer][Layer]] + - [[#auto-completion][Auto-completion]] + - [[#previewing][Previewing]] + - [[#build-command][Build command]] + - [[#auto-fill][Auto-fill]] - [[#keybindings][Keybindings]] - - [[#reftex][RefTeX]] + - [[#reftex][RefTeX]] - [[#maintainer][Maintainer]] * Description @@ -43,7 +43,7 @@ Add the layer =auto-completion= to the variable To perform full-document previews (that is, aside from the inline previewing under ~SPC m p~), add the following to your =.spacemacs= -under =dotspacemacs/config=: +under =dotspacemacs/user-config=: #+BEGIN_SRC emacs-lisp (add-hook 'doc-view-mode-hook 'auto-revert-mode) diff --git a/layers/+lang/ruby/README.org b/layers/+lang/ruby/README.org index 9906e7ce2cee..82bda3b30456 100644 --- a/layers/+lang/ruby/README.org +++ b/layers/+lang/ruby/README.org @@ -5,11 +5,11 @@ * Table of Contents :TOC@4: - [[#description][Description]] - [[#install][Install]] - - [[#prerequisites][Prerequisites]] - - [[#ruby-version-management][Ruby version management]] + - [[#prerequisites][Prerequisites]] + - [[#ruby-version-management][Ruby version management]] - [[#key-bindings][Key bindings]] - - [[#ruby-enh-ruby-mode-robe-inf-ruby-ruby-tools][Ruby (enh-ruby-mode, robe, inf-ruby, ruby-tools)]] - - [[#ruby-test-mode][ruby-test-mode]] + - [[#ruby-enh-ruby-mode-robe-inf-ruby-ruby-tools][Ruby (enh-ruby-mode, robe, inf-ruby, ruby-tools)]] + - [[#ruby-test-mode][ruby-test-mode]] * Description @@ -53,7 +53,7 @@ This layer supports the use of [[https://rvm.io/][RVM]] and [[https://github.com To enable it, set the =ruby-version-manager= var in your =~/.spacemacs=: #+BEGIN_SRC emacs-lisp - (defun dotspacemacs/init () + (defun dotspacemacs/user-init () (setq-default ruby-version-manager 'rbenv) ) #+END_SRC diff --git a/layers/+source-control/git/README.org b/layers/+source-control/git/README.org index 1e04a558726f..ea7e88c9810a 100644 --- a/layers/+source-control/git/README.org +++ b/layers/+source-control/git/README.org @@ -4,22 +4,22 @@ * Table of Contents :TOC@4: - [[#description][Description]] - - [[#features][Features:]] + - [[#features][Features:]] - [[#install][Install]] - - [[#layer][Layer]] - - [[#recommended-settings][Recommended Settings]] - - [[#magit-status-fullscreen][Magit status fullscreen]] - - [[#magit-auto-complete][Magit auto-complete]] - - [[#magit-svn-plugin][Magit SVN plugin]] - - [[#git][Git]] - - [[#git-flow][Git-Flow]] + - [[#layer][Layer]] + - [[#recommended-settings][Recommended Settings]] + - [[#magit-status-fullscreen][Magit status fullscreen]] + - [[#magit-auto-complete][Magit auto-complete]] + - [[#magit-svn-plugin][Magit SVN plugin]] + - [[#git][Git]] + - [[#git-flow][Git-Flow]] - [[#working-with-git][Working with Git]] - - [[#magit][Magit]] - - [[#commit-message-edition-buffer][Commit message edition buffer]] - - [[#interactive-rebase-buffer][Interactive rebase buffer]] - - [[#quick-guide-for-recurring-use-cases-in-magit][Quick guide for recurring use cases in Magit]] - - [[#git-flow][Git-Flow]] - - [[#git-time-machine][Git time machine]] + - [[#magit][Magit]] + - [[#commit-message-edition-buffer][Commit message edition buffer]] + - [[#interactive-rebase-buffer][Interactive rebase buffer]] + - [[#quick-guide-for-recurring-use-cases-in-magit][Quick guide for recurring use cases in Magit]] + - [[#git-flow][Git-Flow]] + - [[#git-time-machine][Git time machine]] * Description @@ -46,22 +46,25 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC *** Recommended Settings -Read the documentation for the =magit-push-always-verify= variable, then you may wish to set it to =nil= in your =dotspacemacs/config= function. +Read the documentation for the =magit-push-always-verify= variable, then you may +wish to set it to =nil= in your =dotspacemacs/user-config= function. #+BEGIN_SRC emacs-lisp -(defun dotspacemacs/config () +(defun dotspacemacs/user-config () (setq magit-push-always-verify nil)) #+END_SRC -The =nag= default is to prevent surprising behavior for newcomers, but causes the ~PP~, ~Po~, ~Pe~ (and more) push commands to nag you in the same way. Once you understand what they do, it is better simply to give the command you intend. +The =nag= default is to prevent surprising behavior for newcomers, but causes +the ~PP~, ~Po~, ~Pe~ (and more) push commands to nag you in the same way. Once +you understand what they do, it is better simply to give the command you intend. ** Magit status fullscreen To display the =magit status= buffer in fullscreen set the variable -=git-magit-status-fullscreen= to =t= in your =dotspacemacs/init= function. +=git-magit-status-fullscreen= to =t= in your =dotspacemacs/user-init= function. #+BEGIN_SRC emacs-lisp - (defun dotspacemacs/init () + (defun dotspacemacs/user-init () (setq-default git-magit-status-fullscreen t) ) #+END_SRC @@ -69,7 +72,7 @@ To display the =magit status= buffer in fullscreen set the variable ** Magit auto-complete Magit auto-complete feature is enabled. For this feature to work best you -have to setup your Git repository directory in your =dotspacemacs/config= +have to setup your Git repository directory in your =dotspacemacs/user-config= function, this is the folder where you keep all your git-controlled projects (the path should end up with a ~=/~= to respect Emacs conventions): @@ -85,7 +88,7 @@ For convenience the magit SVN plugin can be activated directly in the Git layer by setting the variable =git-enable-magit-svn-plugin= to =t=. #+BEGIN_SRC emacs-lisp - (defun dotspacemacs/init () + (defun dotspacemacs/user-init () (setq-default git-enable-magit-svn-plugin t) ) #+END_SRC diff --git a/layers/auto-completion/README.org b/layers/auto-completion/README.org index 57a5652f43bf..10d5ec2f031b 100644 --- a/layers/auto-completion/README.org +++ b/layers/auto-completion/README.org @@ -4,20 +4,20 @@ - [[#description][Description]] - [[#install][Install]] - [[#configuration][Configuration]] - - [[#key-bindings][Key bindings]] - - [[#tooltips][Tooltips]] - - [[#sort-results-by-usage][Sort results by usage]] - - [[#show-snippets-in-auto-completion-popup][Show snippets in auto-completion popup]] - - [[#enable-company-or-auto-complete-globally][Enable company or auto-complete globally]] - - [[#replacing-company-by-auto-complete][Replacing company by auto-complete]] - - [[#add-auto-completion-in-a-layer][Add auto-completion in a layer]] - - [[#in-configel][In =config.el=]] - - [[#in-packagesel][In =packages.el=]] + - [[#key-bindings][Key bindings]] + - [[#tooltips][Tooltips]] + - [[#sort-results-by-usage][Sort results by usage]] + - [[#show-snippets-in-auto-completion-popup][Show snippets in auto-completion popup]] + - [[#enable-company-or-auto-complete-globally][Enable company or auto-complete globally]] + - [[#replacing-company-by-auto-complete][Replacing company by auto-complete]] + - [[#add-auto-completion-in-a-layer][Add auto-completion in a layer]] + - [[#in-configel][In =config.el=]] + - [[#in-packagesel][In =packages.el=]] - [[#key-bindings][Key Bindings]] - - [[#company][Company]] - - [[#auto-complete][Auto-complete]] - - [[#yasnippet][Yasnippet]] - - [[#auto-yasnippet][Auto-yasnippet]] + - [[#company][Company]] + - [[#auto-complete][Auto-complete]] + - [[#yasnippet][Yasnippet]] + - [[#auto-yasnippet][Auto-yasnippet]] * Description @@ -125,7 +125,7 @@ for a given mode. You may want to enable company globally to get auto-completion everywhere even in the modes which are not configured by Spacemacs. To do so, you just have to add =(global-company-mode)= in the -=dotspacemacs/config= function of your dotfile. +=dotspacemacs/user -config= function of your dotfile. Note that if you want to enable =auto-complete= globally you will have to disable =company= first, see the next section to do so. diff --git a/layers/chinese/README.org b/layers/chinese/README.org index 5729009f1c1b..393e3615fe5f 100644 --- a/layers/chinese/README.org +++ b/layers/chinese/README.org @@ -5,15 +5,15 @@ * Table of Contents :TOC@4: - [[#description][Description]] - [[#install][Install]] - - [[#layer][Layer]] - - [[#configuration][Configuration]] - - [[#configure-the-default-input-method配置默认中文输入法][Configure the Default Input Method(配置默认中文输入法)]] - - [[#configure-the-chinese-pyim-input-method配置中文拼音输入法][Configure the =Chinese-pyim= Input Method(配置中文拼音输入法)]] - - [[#enable-youdao有道-dictionary激活有道字典][Enable YouDao(有道) Dictionary(激活有道字典)]] - - [[#set-monospaced-font-size设置等宽字体)][Set monospaced font size(设置等宽字体)]] + - [[#layer][Layer]] + - [[#configuration][Configuration]] + - [[#configure-the-default-input-method配置默认中文输入法][Configure the Default Input Method(配置默认中文输入法)]] + - [[#configure-the-chinese-pyim-input-method配置中文拼音输入法][Configure the =Chinese-pyim= Input Method(配置中文拼音输入法)]] + - [[#enable-youdao有道-dictionary激活有道字典][Enable YouDao(有道) Dictionary(激活有道字典)]] + - [[#set-monospaced-font-size设置等宽字体)][Set monospaced font size(设置等宽字体)]] - [[#key-bindings][Key Bindings]] - - [[#youdao-dictionary][Youdao Dictionary]] - - [[#find-by-pinyin-dired][Find-by-pinyin-dired]] + - [[#youdao-dictionary][Youdao Dictionary]] + - [[#find-by-pinyin-dired][Find-by-pinyin-dired]] * Description This Layer adds Chinese related packages: @@ -63,7 +63,7 @@ You should set `chinese-enable-youdao-dict` to `t`. If you are mixing Chinese words with English words, the text is not perfectly aligned in org table. That's because normally the Chinese font size is not equal to the English font size. You could call =spacemacs//set-monospaced-font= with -your own Chinese font name in =dotspacemacs/config= function. +your own Chinese font name in =dotspacemacs/user-config= function. Example configuration: #+BEGIN_SRC emacs-lisp diff --git a/layers/chinese/config.el b/layers/chinese/config.el index 937574a41a30..dca10874e534 100644 --- a/layers/chinese/config.el +++ b/layers/chinese/config.el @@ -27,7 +27,7 @@ (font-spec :family chinese :size chinese-size)))) ;; If the Hiragino Sans GB font is not found in your system, you could call this -;; method in dotspacemacs/config function with a different Chinese font name. -;; If you are using mac, you could put the following code in your dotspacemacs/config function. +;; method in dotspacemacs/user-config function with a different Chinese font name. +;; If you are using mac, you could put the following code in your dotspacemacs/user-config function. ;; (when (spacemacs/system-is-mac) ;; (spacemacs//set-monospaced-font "Source Code Pro" "Hiragino Sans GB" 14 16)) diff --git a/layers/chrome/README.org b/layers/chrome/README.org index 65131cb0acf9..f47ed9196b78 100644 --- a/layers/chrome/README.org +++ b/layers/chrome/README.org @@ -4,10 +4,10 @@ * Table of Contents :TOC@4: - [[#description][Description]] - - [[#feature][Feature:]] + - [[#feature][Feature:]] - [[#install][Install]] - - [[#layer][Layer]] - - [[#chrome-extension][Chrome extension]] + - [[#layer][Layer]] + - [[#chrome-extension][Chrome extension]] - [[#configuration][Configuration]] * Description @@ -42,7 +42,7 @@ function based on =edit-server-url=, or fall back to =edit-server-default-major-mode= that has a current value of =markdown-mode=. #+BEGIN_SRC emacs-lisp - (defun dotspacemacs/config () + (defun dotspacemacs/user-config () ;; Open github text areas as org buffers ;; currently they are opened as markdown (setq edit-server-url-major-mode-alist diff --git a/layers/deft/README.org b/layers/deft/README.org index bf4fa68c6457..1371144f3177 100644 --- a/layers/deft/README.org +++ b/layers/deft/README.org @@ -40,7 +40,7 @@ To use this contribution add it to your =~/.spacemacs= ** Configuration By default deft tries to put notes in =~/.deft= but you can change -this like so in your =dotspacemacs/config= function: +this like so in your =dotspacemacs/user-config= function: #+BEGIN_SRC emacs-lisp (setq deft-directory "~/Dropbox/notes") diff --git a/layers/finance/README.org b/layers/finance/README.org index ef29d0dcd4ae..ad642c157d7e 100644 --- a/layers/finance/README.org +++ b/layers/finance/README.org @@ -3,11 +3,11 @@ * Table of Contents :TOC@4: - [[#description][Description]] - [[#install][Install]] - - [[#layer][Layer]] + - [[#layer][Layer]] - [[#configuration][Configuration]] - - [[#ledger][Ledger]] + - [[#ledger][Ledger]] - [[#key-bindings][Key bindings]] - - [[#ledger][Ledger]] + - [[#ledger][Ledger]] * Description @@ -32,10 +32,10 @@ To use this contribution add it to your =~/.spacemacs= You can set what column transaction posts are aligned to on the right by setting the variable =ledger-post-amount-alignment-column= in -your =dotspacemacs/config=. The default value, set in the layer, is =62=. +your =dotspacemacs/user-config=. The default value, set in the layer, is =62=. #+BEGIN_SRC emacs-lisp - (defun dotspacemacs/config () + (defun dotspacemacs/user-config () (setq ledger-post-amount-alignment-column 68)) #+END_SRC diff --git a/layers/org/README.org b/layers/org/README.org index b0fec2a7c922..875279ac948f 100644 --- a/layers/org/README.org +++ b/layers/org/README.org @@ -63,7 +63,7 @@ variable. ** Different bullets You can tweak the bullets displayed in the org buffer in the function -=dotspacemacs/config= of your dotfile by setting the variable +=dotspacemacs/user-config= of your dotfile by setting the variable =org-bullets-bullet-list=. By default the list is set to =("◉" "○" "✸" "✿")=. #+BEGIN_SRC emacs-lisp diff --git a/layers/prodigy/README.org b/layers/prodigy/README.org index 70b7e48e0324..5c4973ebfefb 100644 --- a/layers/prodigy/README.org +++ b/layers/prodigy/README.org @@ -6,8 +6,8 @@ - [[#description][Description]] - [[#install][Install]] - [[#key-bindings][Key Bindings]] - - [[#spawn-prodigy][Spawn prodigy]] - - [[#navigate-through-it][Navigate through it]] + - [[#spawn-prodigy][Spawn prodigy]] + - [[#navigate-through-it][Navigate through it]] * Description @@ -15,7 +15,7 @@ This layer adds support for the [[https://github.com/rejeep/prodigy.el][prodigy] within Emacs, check the package's documentation for more details It is recommended to put to put your prodigy services in the -=dotspacemacs/config= part of your =~/.spacemacs= file. +=dotspacemacs/user-config= part of your =~/.spacemacs= file. * Install diff --git a/layers/search-engine/README.org b/layers/search-engine/README.org index 322d98ad8438..64d3f9f6c856 100644 --- a/layers/search-engine/README.org +++ b/layers/search-engine/README.org @@ -4,7 +4,7 @@ * Table of Contents :TOC@4: - [[#description][Description]] - - [[#supported-search-engines][Supported search engines]] + - [[#supported-search-engines][Supported search engines]] - [[#install][Install]] - [[#key-bindings][Key Bindings]] - [[#customize-it][Customize it!]] @@ -47,7 +47,7 @@ To use this contribution add it to your =~/.spacemacs= If you'd rather have emacs use chrome, or firefox or any other thing (=eww=) you can have that customization. For example for google chrome you can put this in -your =dotspacemacs/config=: +your =dotspacemacs/user-config=: #+BEGIN_SRC emacs-lisp (setq browse-url-browser-function 'browse-url-generic @@ -55,7 +55,8 @@ your =dotspacemacs/config=: browse-url-generic-program "google-chrome") #+END_SRC -Also if you want more search engines, just push them (do this in =dotspacemacs/config=) +Also if you want more search engines, just push them (do this in +=dotspacemacs/user-config=) #+BEGIN_SRC emacs-lisp (push '(custom1 diff --git a/layers/spell-checking/README.org b/layers/spell-checking/README.org index eb433a37b80f..aa424b830315 100644 --- a/layers/spell-checking/README.org +++ b/layers/spell-checking/README.org @@ -3,8 +3,8 @@ * Table of Contents :TOC@4: - [[#description][Description]] - [[#install][Install]] - - [[#layer][Layer]] - - [[#spell-checker-configuration][Spell Checker Configuration]] + - [[#layer][Layer]] + - [[#spell-checker-configuration][Spell Checker Configuration]] - [[#key-bindings][Key Bindings]] * Description @@ -24,12 +24,12 @@ To use this configuration layer add it to your =~/.spacemacs= ** Spell Checker Configuration The built-in Emacs variable that controls which external spell-checking program -is used is =ispell-program-name=, which can be set in your =dotspacemacs/init= -function if you do not like the default. It will give priority to =aspell= if it -is installed on your system. Another important variable to be aware of is -=ispell-dictionary= which will control the default dictionary used by -=ispell-program-name= (instead of using this variable you can also use the key -binding ~SPC S d~). +is used is =ispell-program-name=, which can be set in your +=dotspacemacs/user-init= function if you do not like the default. It will give +priority to =aspell= if it is installed on your system. Another important +variable to be aware of is =ispell-dictionary= which will control the default +dictionary used by =ispell-program-name= (instead of using this variable you can +also use the key binding ~SPC S d~). * Key Bindings