mirror of
https://github.com/doomemacs/doomemacs
synced 2025-09-22 16:21:04 -05:00
docs(tramp): add hacks & minor revisions
This commit is contained in:
@@ -8,8 +8,8 @@
|
|||||||
|
|
||||||
* Description :unfold:
|
* Description :unfold:
|
||||||
This module provides sensible and performant defaults for TRAMP, a built-in
|
This module provides sensible and performant defaults for TRAMP, a built-in
|
||||||
Emacs packages that provides remote file editing over various protocols like
|
Emacs package that provides remote file editing over various protocols like SSH,
|
||||||
SSH, SCP, FTP, and more.
|
SCP, FTP, and more.
|
||||||
|
|
||||||
#+begin_quote
|
#+begin_quote
|
||||||
The performance enhancements in this module have the greatest effects in
|
The performance enhancements in this module have the greatest effects in
|
||||||
@@ -28,9 +28,11 @@ SSH, SCP, FTP, and more.
|
|||||||
/This module doesn't install any packages./
|
/This module doesn't install any packages./
|
||||||
|
|
||||||
** Hacks
|
** Hacks
|
||||||
#+begin_quote
|
- Turns on tramp-direct-async-process globally (for improved performance), but
|
||||||
This module's hacks haven't been documented yet. [[doom-contrib-module:][Document them?]]
|
disables it for lsp-mode/eglot connections to LSP servers.
|
||||||
#+end_quote
|
- In remote buffers, several functions are memoized to reduce I/O over TRAMP and
|
||||||
|
improve performance. Currently, these functions are ~magit-toplevel~,
|
||||||
|
~project-current~, and ~vc-git-root~.
|
||||||
|
|
||||||
** TODO Changelog
|
** TODO Changelog
|
||||||
# This section will be machine generated. Don't edit it by hand.
|
# This section will be machine generated. Don't edit it by hand.
|
||||||
@@ -39,6 +41,8 @@ SSH, SCP, FTP, and more.
|
|||||||
* Installation
|
* Installation
|
||||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||||
|
|
||||||
|
/This module has no external requirements./
|
||||||
|
|
||||||
* Usage
|
* Usage
|
||||||
#+begin_quote
|
#+begin_quote
|
||||||
This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
|
||||||
|
Reference in New Issue
Block a user