branch: externals/ivy
commit abb9e1e5649bcd078a2a75bcb27abb42311b4f86
Author: Basil L. Contovounesios <ba...@contovou.net>
Commit: Basil L. Contovounesios <ba...@contovou.net>

    Mention 'make deps' target in more places
    
    * targets/obsolete-config.el:
    * doc/ivy.org (Setup): Add directory names to load-path.
    (Installing from the Git repository):
    * CONTRIBUTING.org (Reporting issues): Mention 'make deps' as a
    prerequisite for installing the 'avy' package.
    * doc/ivy.texi: Regenerate manual.
    * ivy.el (ivy--sorted-files): Add commentary about the potential
    need for substitute-in-file-name (#3060).
---
 CONTRIBUTING.org           |  6 +++---
 doc/ivy.org                | 12 ++++++------
 doc/ivy.texi               |  6 +++---
 ivy.el                     |  2 ++
 targets/obsolete-config.el |  4 ++--
 5 files changed, 16 insertions(+), 14 deletions(-)

diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org
index 6fcc7278ea..772e9ec4ca 100644
--- a/CONTRIBUTING.org
+++ b/CONTRIBUTING.org
@@ -14,9 +14,9 @@ init file.
 This shortcut will start =emacs -Q= for you with =ivy-mode= already
 loaded:
 #+begin_src sh
-git clone https://github.com/abo-abo/swiper/
-cd swiper
-make plain
+  git clone 'https://github.com/abo-abo/swiper.git'
+  cd swiper
+  make deps plain
 #+end_src
 
 * Contributing code
diff --git a/doc/ivy.org b/doc/ivy.org
index cb1191d1d4..9ee954eecf 100644
--- a/doc/ivy.org
+++ b/doc/ivy.org
@@ -18,8 +18,8 @@
 #+STARTUP: indent
 * Setup                                                                        
       :noexport:
 #+BEGIN_SRC elisp :exports results :results silent
-(add-to-list 'load-path default-directory)
-(require 'ivy-ox)
+  (add-to-list 'load-path (directory-file-name default-directory))
+  (require 'ivy-ox)
 #+END_SRC
 * Writing this manual                                                          
       :noexport:
 To highlight a section without introducing a new subheading use
@@ -189,15 +189,15 @@ For package manager details, see [[info:emacs#Packages]].
      First clone the Swiper repository with:
 
      #+begin_src sh
-     cd ~/git && git clone https://github.com/abo-abo/swiper
-     cd swiper && make compile
+       cd ~/git && git clone 'https://github.com/abo-abo/swiper.git'
+       cd swiper && make deps compile
      #+end_src
 
      Second, add these lines to the Emacs init file:
 
      #+begin_src elisp
-     (add-to-list 'load-path "~/git/swiper/")
-     (require 'ivy)
+       (add-to-list 'load-path "~/git/swiper")
+       (require 'ivy)
      #+end_src
 
      Then, update the code with:
diff --git a/doc/ivy.texi b/doc/ivy.texi
index 90c5fa2e16..cabe4383f4 100644
--- a/doc/ivy.texi
+++ b/doc/ivy.texi
@@ -261,14 +261,14 @@ Contribute to Ivy's development; send patches; pull 
requests
 First clone the Swiper repository with:
 
 @example
-cd ~/git && git clone https://github.com/abo-abo/swiper
-cd swiper && make compile
+cd ~/git && git clone 'https://github.com/abo-abo/swiper.git'
+cd swiper && make deps compile
 @end example
 
 Second, add these lines to the Emacs init file:
 
 @lisp
-(add-to-list 'load-path "~/git/swiper/")
+(add-to-list 'load-path "~/git/swiper")
 (require 'ivy)
 @end lisp
 
diff --git a/ivy.el b/ivy.el
index 15bf9bbe55..7a11c9658c 100644
--- a/ivy.el
+++ b/ivy.el
@@ -2037,6 +2037,8 @@ Directories come first."
          (seq (cl-mapcan
                (lambda (f)
                  (unless (member f '("./" "../"))
+                   ;; FIXME: Use `substitute-in-file-name'?
+                   ;; Re: #2012, #3060.
                    (setq f (ivy--string-replace "$$" "$" f))
                    (list (if (and dirs-first (ivy--dirname-p f))
                              (propertize f 'ivy--dir (directory-file-name f))
diff --git a/targets/obsolete-config.el b/targets/obsolete-config.el
index 6960ea6c54..516168a6a1 100644
--- a/targets/obsolete-config.el
+++ b/targets/obsolete-config.el
@@ -1,5 +1,5 @@
 ;; Copyright (C) 2016-2024 Free Software Foundation, Inc.
-(add-to-list 'load-path default-directory)
+(add-to-list 'load-path (directory-file-name default-directory))
 (require 'counsel)
-(ivy-set-display-transformer 'ivy-switch-buffer 'ivy-switch-buffer-transformer)
+(ivy-set-display-transformer 'ivy-switch-buffer 
#'ivy-switch-buffer-transformer)
 (byte-compile-file (expand-file-name "targets/obsolete-config.el"))

Reply via email to