picnoir
/
my-repo-pins
mirror of https://github.com/NinjaTrappeur/my-repo-pins.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

open-function: add some more docs

This commit is contained in:
Félix Baylac Jacqué 2023-01-02 14:05:56 +01:00
parent 04715d88f1
commit 9cde40c311
No known key found for this signature in database
GPG Key ID: EFD315F31848DBA4
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -106,6 +106,14 @@ Path pointing to the git binary. By default, it'll look for git in the current `
Alist in the form of `("FORGE NAME" . FETCH-FUNCTION)` where `FETCH-FUNCTION` is a function in charge of retrieving a potential remote clone URL. More about this function in the [Fetchers](#fetchers) section.
### my-repo-pins-open-function
The my-repo-pins-open-function variable can be customized if you would prefer to land in some other program than Dired. Good candidates might be the builtin 'vc-dir or 'magit-status if you use the popular Magit package:
```elisp
(setq my-repo-pins-open-function 'vc-dir)
```
## Fetchers
When a repository cannot be found in the code root directory, `my-repo-pins` will try to download it from different forges. By default, it'll try to find it on github.com, gitlab.com, git.sr.ht, and codeberg.org.

1
my-repo-pins.el
View File

@ -579,6 +579,7 @@ yet, returns an empty list."
:group 'my-repo-pins-group)
(defun my-repo-pins--open (dir)
"Open the DIR directory using the ‘my-repo-pins-code-root’ function."
(funcall my-repo-pins-open-function dir))
;;=============