awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-01 12:17:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

(doc): add note on unlinked references and encrypted files (#1236)

Browse Source
This commit is contained in:
Jethro Kuan
2020-11-05 16:34:11 +08:00
committed by GitHub
parent b184cdaef0
commit 4d423a916e
2 changed files with 15 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/org-roam.org
View File

@ -1055,11 +1055,16 @@ facilities for discovering these unlinked references, so one may decide whether
to convert them into links. to convert them into links.
To use this feature, simply call ~M-x org-roam-unlinked-references~ from within To use this feature, simply call ~M-x org-roam-unlinked-references~ from within
an Org-roam note. Org-roam uses [[https://github.com/BurntSushi/ripgrep][ripgrep]], specifically a clever PCRE regex to an Org-roam note. Internally, Org-roam uses [[https://github.com/BurntSushi/ripgrep][ripgrep]] and a clever PCRE regex to
find occurrences of the title or aliases of the currently open note in all find occurrences of the title or aliases of the currently open note in all
Org-roam files. This thus requires a version of ripgrep that is compiled with Org-roam files. Hence, this requires a version of ripgrep that is compiled with
PCRE support. PCRE support.
#+begin_quote
NOTE: Since ripgrep cannot read encrypted files, this function cannot find
unlinked references within encrypted files.
#+end_quote
* Performance Optimization * Performance Optimization
** TODO Profiling Key Operations ** TODO Profiling Key Operations
** Garbage Collection ** Garbage Collection

10
doc/org-roam.texi
View File

@ -1396,11 +1396,17 @@ facilities for discovering these unlinked references, so one may decide whether
to convert them into links. to convert them into links.
To use this feature, simply call @code{M-x org-roam-unlinked-references} from within To use this feature, simply call @code{M-x org-roam-unlinked-references} from within
an Org-roam note. Org-roam uses @uref{https://github.com/BurntSushi/ripgrep, ripgrep}, specifically a clever PCRE regex to an Org-roam note. Internally, Org-roam uses @uref{https://github.com/BurntSushi/ripgrep, ripgrep} and a clever PCRE regex to
find occurrences of the title or aliases of the currently open note in all find occurrences of the title or aliases of the currently open note in all
Org-roam files. This thus requires a version of ripgrep that is compiled with Org-roam files. Hence, this requires a version of ripgrep that is compiled with
PCRE support. PCRE support.
@quotation
NOTE: Since ripgrep cannot read encrypted files, this function cannot find
unlinked references within encrypted files.
@end quotation
@node Performance Optimization @node Performance Optimization
@chapter Performance Optimization @chapter Performance Optimization