diff --git a/manual/Appendix.html b/manual/Appendix.html index 87b2cfc..d93cd9d 100644 --- a/manual/Appendix.html +++ b/manual/Appendix.html @@ -26,7 +26,7 @@ General Public License for more details. - + + + + + + + + +
+

+Previous: , Up: Performance Optimization   [Contents]

+
+
+ +

15.2 Garbage Collection

+ +

During the cache-build process, Org-roam generates a lot of in-memory +data-structures (such as the Org file’s AST), which are discarded after use. These structures are garbage collected at regular intervals (see (elisp)info:elisp#Garbage Collection). +

+

Org-roam provides the option org-roam-db-gc-threshold to temporarily change +the threshold value for GC to be triggered during these memory-intensive +operations. To reduce the number of garbage collection processes, one may set +org-roam-db-gc-threshold to a high value (such as most-positive-fixnum): +

+
+
(setq org-roam-db-gc-threshold most-positive-fixnum)
+
+ + + + + + diff --git a/manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html b/manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html index aee7205..d58e51c 100644 --- a/manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html +++ b/manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html @@ -67,7 +67,7 @@ Next: -

16.1 How do I have more than one Org-roam directory?

+

17.1 How do I have more than one Org-roam directory?

Emacs supports directory-local variables, allowing the value of ‘org-roam-directory’ to be different in different directories. It does this by diff --git a/manual/How-do-I-migrate-from-Roam-Research_003f.html b/manual/How-do-I-migrate-from-Roam-Research_003f.html index 6dad23c..4be0c5d 100644 --- a/manual/How-do-I-migrate-from-Roam-Research_003f.html +++ b/manual/How-do-I-migrate-from-Roam-Research_003f.html @@ -66,7 +66,7 @@ Previous: -

16.2 How do I migrate from Roam Research?

+

17.2 How do I migrate from Roam Research?

Fabio has produced a command-line tool that converts markdown files exported from Roam Research into Org-roam compatible markdown. More instructions are provided in the repository.

diff --git a/manual/Note_002dtaking-Add_002dons.html b/manual/Note_002dtaking-Add_002dons.html index 3449a9e..2a05c96 100644 --- a/manual/Note_002dtaking-Add_002dons.html +++ b/manual/Note_002dtaking-Add_002dons.html @@ -67,7 +67,7 @@ Previous: -

15.2.3 Note-taking Add-ons

+

16.2.3 Note-taking Add-ons

These are some plugins that make note-taking in Org-mode more enjoyable.

diff --git a/manual/Note_002dtaking-Workflows.html b/manual/Note_002dtaking-Workflows.html index be1074f..699872b 100644 --- a/manual/Note_002dtaking-Workflows.html +++ b/manual/Note_002dtaking-Workflows.html @@ -67,7 +67,7 @@ Next: ,
-

15.1 Note-taking Workflows

+

16.1 Note-taking Workflows

Books
diff --git a/manual/Org_002djournal.html b/manual/Org_002djournal.html index 44386d5..0b1ffaf 100644 --- a/manual/Org_002djournal.html +++ b/manual/Org_002djournal.html @@ -67,7 +67,7 @@ Next:
-

15.2.2 Org-journal

+

16.2.2 Org-journal

Org-journal is a more powerful alternative to the simple function ‘org-roam-dailies-today’. It diff --git a/manual/Performance-Optimization.html b/manual/Performance-Optimization.html new file mode 100644 index 0000000..f8830e5 --- /dev/null +++ b/manual/Performance-Optimization.html @@ -0,0 +1,83 @@ + + + + + + +Performance Optimization (Org-roam User Manual) + + + + + + + + + + + + + + + + + + + +

+

+Next: , Previous: , Up: Top   [Contents]

+
+
+ +

15 Performance Optimization

+ + + + +
• Profiling Key Operations:   +
• Garbage Collection:   +
+ + + + + + diff --git a/manual/Profiling-Key-Operations.html b/manual/Profiling-Key-Operations.html new file mode 100644 index 0000000..1dc42bb --- /dev/null +++ b/manual/Profiling-Key-Operations.html @@ -0,0 +1,76 @@ + + + + + + +Profiling Key Operations (Org-roam User Manual) + + + + + + + + + + + + + + + + + + + +
+

+Next: , Up: Performance Optimization   [Contents]

+
+
+ +

15.1 TODO Profiling Key Operations

+ + + + + + diff --git a/manual/index.html b/manual/index.html index 83127a0..e1bb49c 100644 --- a/manual/index.html +++ b/manual/index.html @@ -117,14 +117,19 @@ ul.no-bullet {list-style: none}
  • 13 TODO Daily Notes
  • 14 Diagnosing and Repairing Files
    • -
  • 15 Appendix +
  • 15 Performance Optimization
    • +
  • 16 Appendix +
    • -
  • 16 FAQ +
  • 17 FAQ
    • @@ -198,6 +203,8 @@ General Public License for more details. • Diagnosing and Repairing Files:   +• Performance Optimization:   + • Appendix:   • FAQ:   @@ -272,6 +279,14 @@ Roam Protocol 
     
+Performance Optimization
+
+
    • Profiling Key Operations:   + +• Garbage Collection:   + +
    +
 Appendix
    • Note-taking Workflows:   diff --git a/org-roam.org b/org-roam.org index ac7485b..9f78da1 100644 --- a/org-roam.org +++ b/org-roam.org @@ -831,6 +831,22 @@ checker, to perform autofixes for the errors. For each error detected, =org-roam-doctor= will move the point to the current error, and pop-up a help window displaying the error message, as well as the list of actions that can be taken provided in =:actions=. +* Performance Optimization +** TODO Profiling Key Operations +** Garbage Collection + +During the cache-build process, Org-roam generates a lot of in-memory +data-structures (such as the Org file's AST), which are discarded after use. These structures are garbage collected at regular intervals (see [[info:elisp#Garbage Collection][info:elisp#Garbage Collection]]). + +Org-roam provides the option ~org-roam-db-gc-threshold~ to temporarily change +the threshold value for GC to be triggered during these memory-intensive +operations. To reduce the number of garbage collection processes, one may set +~org-roam-db-gc-threshold~ to a high value (such as ~most-positive-fixnum~): + +#+BEGIN_SRC emacs-lisp + (setq org-roam-db-gc-threshold most-positive-fixnum) +#+END_SRC + * _ Copying :PROPERTIES: :COPYING: t diff --git a/org-roam.texi b/org-roam.texi index 37db469..cb6f715 100644 --- a/org-roam.texi +++ b/org-roam.texi @@ -78,6 +78,7 @@ General Public License for more details. * Roam Protocol:: * Daily Notes:: * Diagnosing and Repairing Files:: +* Performance Optimization:: * Appendix:: * FAQ:: @@ -124,6 +125,11 @@ Roam Protocol * The @samp{roam-file} protocol:: * The @samp{roam-ref} Protocol:: +Performance Optimization + +* Profiling Key Operations:: +* Garbage Collection:: + Appendix * Note-taking Workflows:: @@ -1128,6 +1134,32 @@ checker, to perform autofixes for the errors. For each error detected, window displaying the error message, as well as the list of actions that can be taken provided in @samp{:actions}. +@node Performance Optimization +@chapter Performance Optimization + +@menu +* Profiling Key Operations:: +* Garbage Collection:: +@end menu + +@node Profiling Key Operations +@section @strong{TODO} Profiling Key Operations + +@node Garbage Collection +@section Garbage Collection + +During the cache-build process, Org-roam generates a lot of in-memory +data-structures (such as the Org file's AST), which are discarded after use. These structures are garbage collected at regular intervals (see @ref{Garbage Collection,info:elisp#Garbage Collection,,elisp,}). + +Org-roam provides the option @code{org-roam-db-gc-threshold} to temporarily change +the threshold value for GC to be triggered during these memory-intensive +operations. To reduce the number of garbage collection processes, one may set +@code{org-roam-db-gc-threshold} to a high value (such as @code{most-positive-fixnum}): + +@lisp +(setq org-roam-db-gc-threshold most-positive-fixnum) +@end lisp + @node Appendix @chapter Appendix