doc: auto generate

moyiz · Jun 24, 2024 · a80a18f · a80a18f
1 parent b9477e7
commit a80a18f
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 12 deletions.
diff --git a/doc/git-dev.txt b/doc/git-dev.txt
@@ -1,4 +1,4 @@
-*git-dev.txt*             For NVIM v0.8.0            Last change: 2024 June 22
+*git-dev.txt*             For NVIM v0.8.0            Last change: 2024 June 24
 
 ==============================================================================
 Table of Contents                                  *git-dev-table-of-contents*
@@ -9,6 +9,7 @@ Table of Contents                                  *git-dev-table-of-contents*
   - Clean All                                        |git-dev-usage-clean-all|
   - Parse                                                |git-dev-usage-parse|
   - Toggle UI                                        |git-dev-usage-toggle-ui|
+  - Telescope                                        |git-dev-usage-telescope|
 3. Options                                                   |git-dev-options|
 4. URL Parsing                                           |git-dev-url-parsing|
   - Supported URLs                        |git-dev-url-parsing-supported-urls|
@@ -22,7 +23,6 @@ Table of Contents                                  *git-dev-table-of-contents*
   - Web browser                                  |git-dev-recipes-web-browser|
   - Customizing Default URL          |git-dev-recipes-customizing-default-url|
   - Private Repositories - Parse HTTP as SSH|git-dev-recipes-private-repositories---parse-http-as-ssh|
-  - Telescope                                      |git-dev-recipes-telescope|
 =============================================================================
 
 
@@ -33,6 +33,7 @@ Table of Contents                                  *git-dev-table-of-contents*
 - Supports most URLs from GitHub, GitLab, Gitea and Codeberg.
 - Seamless integration with your workflow (e.g. LSP and tree-sitter).
 - Ephemeral repositories - cleanup when Neovim exits.
+- Telescope extension to revisit previously opened repositories.
 
 
 ==============================================================================
@@ -50,7 +51,8 @@ Open the repository in Neovim.
 
 PARAMETERS ~
 
-- `repo` - `string` - A partial or full Git URI.
+- `repo` - `string` - A partial or full Git URI. Some non-git URIs are also
+    supported, see |git-dev-supported-urls| for examples.
 - `ref` - `table` - Target reference to checkout (default: `nil`). Empty `ref`
     will checkout the default branch.
     Examples: `{ branch = "..." }|{ tag = "..." }|{ commit = "..." }`.
@@ -124,6 +126,21 @@ PARAMETERS ~
     for this call.
 
 
+TELESCOPE                                            *git-dev-usage-telescope*
+
+
+RECENT REPOSITORIES ~
+
+Command: `GitDevRecents`
+
+Revisit previously opened repositories via a telescope extension.
+
+Opened repositories are tracked in a simple single file KV store. Its only
+purpose (currently) is to be queried by the telescope extension for a
+convenient way to re-open previously opened repositories. See `history` in
+|git-dev-options| below.
+
+
 ==============================================================================
 3. Options                                                   *git-dev-options*
 
@@ -175,13 +192,13 @@ PARAMETERS ~
         -- Triggered when a branch, tag or commit is given.
         checkout_args = "-f --recurse-submodules",
       },
-      -- UI configuration
+      -- UI configuration.
       ui = {
         -- Auto-close window after repository was opened.
         auto_close = true,
         -- Delay window closing.
         close_after_ms = 3000,
-        -- Window mode. A workaround to remove `relative`.
+        -- Window mode.
         -- Options: floating|split
         mode = "floating",
         -- Window configuration for floating mode.
@@ -198,16 +215,25 @@ PARAMETERS ~
           height = 9,
           row = 1,
           col = vim.o.columns,
+          noautocmd = true,
         },
         -- Window configuration for split mode.
         -- See `:h nvim_open_win`.
         ---@type win_config
         split_win_config = {
           split = "right",
           width = 79,
+          noautocmd = true,
         },
       },
-      -- Print command outputs.
+      -- History configuration.
+      history = {
+        -- Maximum number of records to keep in history.
+        n = 32,
+        -- Store file path.
+        path = vim.fn.stdpath "data" .. "/git-dev/history.json",
+      },
+      -- More verbosity.
       verbose = false,
     }
 <
@@ -486,11 +512,6 @@ Then, the parser trims the "domain" and proceeds as usual. Output:
     }
 <
 
-
-TELESCOPE                                          *git-dev-recipes-telescope*
-
-TBD
-
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
 
 vim:tw=78:ts=8:noet:ft=help:norl:
diff --git a/doc/tags b/doc/tags
@@ -6,7 +6,6 @@ git-dev-recipes-interactive-opening	git-dev.txt	/*git-dev-recipes-interactive-op
 git-dev-recipes-neo-tree	git-dev.txt	/*git-dev-recipes-neo-tree*
 git-dev-recipes-new-tab	git-dev.txt	/*git-dev-recipes-new-tab*
 git-dev-recipes-nvim-tree	git-dev.txt	/*git-dev-recipes-nvim-tree*
-git-dev-recipes-telescope	git-dev.txt	/*git-dev-recipes-telescope*
 git-dev-recipes-web-browser	git-dev.txt	/*git-dev-recipes-web-browser*
 git-dev-table-of-contents	git-dev.txt	/*git-dev-table-of-contents*
 git-dev-url-parsing	git-dev.txt	/*git-dev-url-parsing*
@@ -17,5 +16,6 @@ git-dev-usage	git-dev.txt	/*git-dev-usage*
 git-dev-usage-clean-all	git-dev.txt	/*git-dev-usage-clean-all*
 git-dev-usage-open	git-dev.txt	/*git-dev-usage-open*
 git-dev-usage-parse	git-dev.txt	/*git-dev-usage-parse*
+git-dev-usage-telescope	git-dev.txt	/*git-dev-usage-telescope*
 git-dev-usage-toggle-ui	git-dev.txt	/*git-dev-usage-toggle-ui*
 git-dev.txt	git-dev.txt	/*git-dev.txt*