diff options
| author | Eli Zaretskii | 2019-07-13 11:06:14 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2019-07-13 11:06:14 +0300 |
| commit | bd962f7fd471a07bae1950976e066ad0c3009532 (patch) | |
| tree | 52588f3f78a64b2e1507fd8b073aa422118bb9c8 | |
| parent | 70225ecae1fc3069a59384f2ff3576bbba4e1037 (diff) | |
| download | emacs-bd962f7fd471a07bae1950976e066ad0c3009532.tar.gz emacs-bd962f7fd471a07bae1950976e066ad0c3009532.zip | |
Improve documentation of So Long mode
* doc/emacs/trouble.texi (Long Lines): Improve wording, add
indexing, mention the mode name and its main customization
options.
| -rw-r--r-- | doc/emacs/trouble.texi | 31 |
1 files changed, 21 insertions, 10 deletions
diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi index aa940208214..13d3e8475ce 100644 --- a/doc/emacs/trouble.texi +++ b/doc/emacs/trouble.texi | |||
| @@ -469,19 +469,30 @@ in unusual circumstances), Emacs can perform poorly when extremely | |||
| 469 | long lines are present (where ``extremely long'' usually means at | 469 | long lines are present (where ``extremely long'' usually means at |
| 470 | least many thousands of characters). | 470 | least many thousands of characters). |
| 471 | 471 | ||
| 472 | @cindex @code{so-long} mode | ||
| 473 | @findex global-so-long-mode | ||
| 474 | @vindex so-long-action | ||
| 472 | A particular problem is that Emacs may ``hang'' for a long time at | 475 | A particular problem is that Emacs may ``hang'' for a long time at |
| 473 | the point of visiting a file with extremely long lines, and this case | 476 | the point of visiting a file with extremely long lines. This can be |
| 474 | can be mitigated by enabling the @file{so-long} library, which detects | 477 | mitigated by enabling the @file{so-long} library, which detects when a |
| 475 | when a visited file contains abnormally long lines, and takes steps to | 478 | visited file contains abnormally long lines, and takes steps to |
| 476 | disable features which are liable to cause slowness in that situation. | 479 | disable features which are liable to cause slowness in that situation. |
| 477 | 480 | To enable this library, type @kbd{M-x global-so-long-mode @key{RET}}, | |
| 478 | This library can also significantly improve performance when moving | 481 | or turn on the @code{global-so-long-mode} in your init file |
| 479 | and editing in such a buffer -- performance is still likely to degrade | 482 | (@pxref{Init File}), or customize the @code{global-so-long-mode} |
| 480 | as you get deeper into the long lines, but the improvements can | 483 | option. You can tailor this mode's operation by customizing the |
| 481 | nevertheless be substantial. | 484 | variable @code{so-long-action}. |
| 482 | 485 | ||
| 486 | The @file{so-long} library can also significantly improve | ||
| 487 | performance when moving and editing in a buffer with long lines. | ||
| 488 | Performance is still likely to degrade as you get deeper into the long | ||
| 489 | lines, but the improvements from using this library can nevertheless | ||
| 490 | be substantial. | ||
| 491 | |||
| 492 | @findex so-long-commentary | ||
| 483 | Use @kbd{M-x so-long-commentary} to view the documentation for this | 493 | Use @kbd{M-x so-long-commentary} to view the documentation for this |
| 484 | library and learn how to enable and configure it. | 494 | library and learn more about how to enable and configure it. |
| 495 | |||
| 485 | @node Bugs | 496 | @node Bugs |
| 486 | @section Reporting Bugs | 497 | @section Reporting Bugs |
| 487 | 498 | ||