Merge pull request #368 from mrjones2014/bot/vimdoc/master

chore: generated vimdoc
mrjones2014 · May 8, 2023 · 2f59e16 · 2f59e16
2 parents a30d393 + a4ecfae
commit 2f59e16
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 2 deletions.
diff --git a/doc/legendary.txt b/doc/legendary.txt
@@ -1,4 +1,4 @@
-*legendary.txt*                                     Last change: 2023 April 10
+*legendary.txt*                                       Last change: 2023 May 08
 
 ==============================================================================
 Table of Contents                                *legendary-table-of-contents*
@@ -8,6 +8,7 @@ Prerequisites ...................................... |legendary-prerequisites|
 Installation ........................................ |legendary-installation|
 Quickstart ............................................ |legendary-quickstart|
 Configuration ...................................... |legendary-configuration|
+Troubleshooting Frecency Sort ...... |legendary-troubleshooting-frecency-sort|
 
 ==============================================================================
 `LEGENDARY.NVIM`                                    *legendary-legendary.nvim*
@@ -30,11 +31,14 @@ telescope.nvim <https://github.com/nvim-telescope/telescope.nvim> via
 dressing.nvim <https://github.com/stevearc/dressing.nvim>. See Prerequisites
 <#prerequisites> for details.</sup>
 
+**Table of Contents**
+
 - Features <#features>
 - Prerequisites <#prerequisites>
 - Installation <#installation>
 - Quickstart <#quickstart>
-- Configuration <#configuration>
+- Configuration <#configuration> - Troubleshooting Frecency Sort
+  <#troubleshooting-frecency-sort>
 - Keymap Development Utilities <./doc/MAPPING_DEVELOPMENT.md>
 - `which-key.nvim` Integration <./doc/WHICH_KEY.md>
 - Lua API <./doc/API.md>
@@ -455,6 +459,36 @@ doc/table_structures/README.md <./doc/table_structures/README.md>.
       log_level = 'info',
     })
 <
+
+
+TROUBLESHOOTING FRECENCY SORT        *legendary-troubleshooting-frecency-sort*
+
+If you get an error along the lines of the following, and frecency sorting
+does not work:
+
+>
+    Failed to open database at /Users/mat/.local/share/nvim/legendary/legendary_frecency.sqlite3: ...at/.local/share/nvim/lazy/sqlite.lua/lua/sqlite/defs.lua:56: dlopen(lib.dylib, 0x0005): tried: 'lib.dylib' (no such file), '/System/Volumes/Preboot/Cryptexes/OSlib.dylib' (no such file), '/nix/store/092zx4zf4fmj0jyk32jl1ihix6q4bmw4-apple-framework-CoreFoundation-11.0.0/Library/Frameworks/lib.dylib' (no such file), '/System/Volumes/Preboot/Cryptexes/OS/nix/store/092zx4zf4fmj0jyk32jl1ihix6q4bmw4-apple-framework-CoreFoundation-11.0.0/Library/Frameworks/lib.dylib' (no such file), '/nix/store/092zx4zf4fmj0jyk32jl1ihix6q4bmw4-apple-framework-CoreFoundation-11.0.0/Library/Frameworks/lib.dylib' (no such file), '/System/Volumes/Preboot/Cryptexes/OS/nix/store/092zx4zf4fmj0jyk32jl1ihix6q4bmw4-apple-framework-CoreFoundation-11.0.0/Library/Frameworks/lib.dylib' (no such file), '/usr/lib/lib.dylib' (no such file, not in dyld cache), 'lib.dylib' (no such file), '/usr/local/lib/lib.dylib' (no such file), '/usr/lib/lib.dylib' (no such file, not in dyld cache)
+<
+This means that the `sqlite.lua` Lua library was unable to find the
+`libsqlite3.dylib` shared library file. This could be the case for a few
+reasons. To fix this, you can either set `vim.g.sqlite_clib_path` in your
+Neovim config, or the `LIBSQLITE` environment variable to the full path to
+`libsqlite3.dylib`. If you are using Nix with `home-manager`, this can be done
+like so:
+
+>nix
+    {
+      home.sessionVariables = {
+        LIBSQLITE = "${pkgs.sqlite.out}/lib/libsqlite3.dylib";
+      };
+    }
+<
+If you are _not_ using Nix, you can locate the `libsqlite3.dylib` on macOS by
+running:
+
+>shell
+    otool -L $(which sqlite3) | grep "sqlite3.dylib"
+<
 Additional documentation can be found under doc/ <./doc/>.
 
 

diff --git a/doc/tags b/doc/tags
@@ -56,6 +56,7 @@ legendary-tables-in-place-item-filters	legendary-tables.txt	/*legendary-tables-i
 legendary-tables-table-of-contents	legendary-tables.txt	/*legendary-tables-table-of-contents*
 legendary-tables-table-structures	legendary-tables.txt	/*legendary-tables-table-structures*
 legendary-tables.txt	legendary-tables.txt	/*legendary-tables.txt*
+legendary-troubleshooting-frecency-sort	legendary.txt	/*legendary-troubleshooting-frecency-sort*
 legendary-usage-examples-table-of-contents	legendary-usage-examples.txt	/*legendary-usage-examples-table-of-contents*
 legendary-usage-examples-usage-examples	legendary-usage-examples.txt	/*legendary-usage-examples-usage-examples*
 legendary-usage-examples.txt	legendary-usage-examples.txt	/*legendary-usage-examples.txt*