Skip to content

Commit e0d763a

Browse files
committed
docs: document the new GitDevPersist command
1 parent 5ddd3dc commit e0d763a

2 files changed

Lines changed: 35 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ Lazier (documentation will not be available until first use):
105105
"GitDevClean",
106106
"GitDevCleanAll",
107107
"GitDevCloseBuffers",
108+
"GitDevPersist",
108109
"GitDevOpen",
109110
"GitDevRecents",
110111
"GitDevToggleUI",
@@ -167,6 +168,22 @@ Supports auto-completion.
167168
- `repo` - Same as `open`.
168169
- `ref` - Same as `open`.
169170

171+
### :floppy_disk: Persist Repository
172+
API: `require("git-dev").persist(repo, ref)`
173+
174+
Command: `GitDevPersist`
175+
176+
Make an ephemeral repository persistent. It will not be deleted when Neovim
177+
exits.
178+
If `repo` is omitted, try to determine repository from current buffer.
179+
If `ref` is omitted, assume it is related to current buffer if an explicit
180+
repository was given.
181+
Supports auto-completion.
182+
183+
#### Parameters
184+
- `repo` - Same as `open`.
185+
- `ref` - Same as `open`.
186+
170187
### :toothbrush: Clean
171188
API: `require("git-dev").clean(repo, ref, opts)`
172189

doc/git-dev.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,24 @@ PARAMETERS ~
9292
- `ref` - Same as `open`.
9393

9494

95+
PERSIST *git-dev-usage-persist*
96+
97+
API: `require("git-dev").persist(repo, ref)`
98+
99+
Command: `GitDevPersist`
100+
101+
Make an ephemeral repository persistent. It will not be deleted when Neovim
102+
exits. If `repo` is omitted, try to determine repository from current buffer. If
103+
`ref` is omitted, assume it is related to current buffer if an explicit
104+
repository was given. Supports auto-completion.
105+
106+
107+
PARAMETERS ~
108+
109+
- `repo` - Same as `open`.
110+
- `ref` - Same as `open`.
111+
112+
95113
CLEAN *git-dev-usage-clean*
96114

97115
API: `require("git-dev").clean(repo, ref, opts)`

0 commit comments

Comments
 (0)