awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-09-26 16:40:56 -05:00
Code Issues Packages Projects Releases Wiki Activity

(feat): replace org-roam-{setup,teardown} with org-roam-db-autosync-mode (#1758)

Browse Source 
Comply with the principle of least astonishment, where in Emacs having a
global minor mode for this purpose would be the most expected thing to
have.
This commit is contained in:
Wetlize
2021-08-10 09:02:17 +03:00
committed by GitHub
parent 39cd819cfa
commit 5dce6261a2
7 changed files with 127 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/org-roam.org
View File

@@ -308,7 +308,7 @@ is to use [[https://www.msys2.org/][MSYS2]] as at the time of this writing:
Note that you do not need to manually set the PATH for MSYS2; the
installer automatically takes care of it for you.
4. Open Emacs and call ~M-x org-roam-setup~
4. Open Emacs and call ~M-x org-roam-db-autosync-mode~
This will automatically start compiling ~emacsql-sqlite~; you should see a
message in minibuffer. It may take a while until compilation completes. Once
@@ -376,12 +376,12 @@ The ~file-truename~ function is only necessary when you use symbolic links
inside ~org-roam-directory~: Org-roam does not resolve symbolic links.
Next, we setup Org-roam to run functions on file changes to maintain cache
consistency. This is achieved by running ~M-x org-roam-setup~. To ensure that
Org-roam is available on startup, place this in your Emacs configuration:
consistency. This is achieved by running ~M-x org-roam-db-autosync-mode~. To
ensure that Org-roam is available on startup, place this in your Emacs
configuration:
#+begin_src emacs-lisp
(require 'org-roam)
(org-roam-setup)
(org-roam-db-autosync-mode)
#+end_src
To build the cache manually, run ~M-x org-roam-db-sync~. Cache builds may

10
doc/org-roam.texi
View File

@@ -550,7 +550,7 @@ installer automatically takes care of it for you.
@itemize
@item
Open Emacs and call @code{M-x org-roam-setup}
Open Emacs and call @code{M-x org-roam-db-autosync-mode}
This will automatically start compiling @code{emacsql-sqlite}; you should see a
@end itemize
@@ -637,12 +637,12 @@ The @code{file-truename} function is only necessary when you use symbolic links
inside @code{org-roam-directory}: Org-roam does not resolve symbolic links.
Next, we setup Org-roam to run functions on file changes to maintain cache
consistency. This is achieved by running @code{M-x org-roam-setup}. To ensure that
Org-roam is available on startup, place this in your Emacs configuration:
consistency. This is achieved by running @code{M-x org-roam-db-autosync-mode~}.
To ensure that Org-roam is available on startup, place this in your Emacs
configuration:
@lisp
(require 'org-roam)
(org-roam-setup)
(org-roam-db-autosync-mode)
@end lisp
To build the cache manually, run @code{M-x org-roam-db-sync}. Cache builds may