Skip to content

Commit

Permalink
Mention 'make deps' target in more places
Browse files Browse the repository at this point in the history
* 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).
  • Loading branch information
basil-conto committed Jan 9, 2025
1 parent 2393ed2 commit abb9e1e
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 14 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions doc/ivy.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions doc/ivy.texi
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions ivy.el
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down
4 changes: 2 additions & 2 deletions targets/obsolete-config.el
Original file line number Diff line number Diff line change
@@ -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"))

0 comments on commit abb9e1e

Please sign in to comment.