[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/emacs-gc-stats 30340df54c 18/24: Use Org for README sou
From: |
ELPA Syncer |
Subject: |
[elpa] externals/emacs-gc-stats 30340df54c 18/24: Use Org for README source |
Date: |
Sat, 10 Jun 2023 12:58:45 -0400 (EDT) |
branch: externals/emacs-gc-stats
commit 30340df54c11e0e665fcd5372876a52dcc0f1ef3
Author: Ihor Radchenko <yantar92@posteo.net>
Commit: Ihor Radchenko <yantar92@posteo.net>
Use Org for README source
* README.org: New file, containing `after-save-hook' for md export.
* README.md: Re-generate.
---
README.md | 16 ++++++++--------
README.org | 24 ++++++++++++++++++++++++
2 files changed, 32 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 517322f6b4..27ab27b449 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,16 @@
This package collects Emacs garbage statistics over time and saves it
in the format that can be shared with Emacs maintainers.
+
# Usage
Add
-``` lisp
-(require 'emacs-gc-stats)
-;; optional
-(setq gc-cons-threshold
- (* 800000 (seq-random-elt '(1 2 4 8 16 32 64 128))))
-(emacs-gc-stats-mode +1)
-```
+ (require 'emacs-gc-stats)
+ ;; optional
+ (setq gc-cons-threshold
+ (* 800000 (seq-random-elt '(1 2 4 8 16 32 64 128))))
+ (emacs-gc-stats-mode +1)
to your init file to enable the statistics acquiring.
@@ -19,5 +18,6 @@ When you are ready to share the results, run `M-x
emacs-gc-stats-save-session`
and then share the saved `emacs-gc-stats-file` (defaults to
`~/.emacs.d/emacs-gc-stats.eld`).
-You can use `emacs-gc-stats-clear` to clear the currently collected
+You can use `M-x emacs-gc-stats-clear` to clear the currently collected
session data.
+
diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..d6ef6967ab
--- /dev/null
+++ b/README.org
@@ -0,0 +1,24 @@
+# -*- after-save-hook: (org-md-export-to-markdown); -*-
+#+options: toc:nil
+
+This package collects Emacs garbage statistics over time and saves it
+in the format that can be shared with Emacs maintainers.
+
+* Usage
+
+Add
+#+begin_src emacs-lisp
+(require 'emacs-gc-stats)
+;; optional
+(setq gc-cons-threshold
+ (* 800000 (seq-random-elt '(1 2 4 8 16 32 64 128))))
+(emacs-gc-stats-mode +1)
+#+end_src
+to your init file to enable the statistics acquiring.
+
+When you are ready to share the results, run =M-x emacs-gc-stats-save-session=
+and then share the saved ~emacs-gc-stats-file~ (defaults to
+=~/.emacs.d/emacs-gc-stats.eld=).
+
+You can use =M-x emacs-gc-stats-clear= to clear the currently collected
+session data.
- [elpa] externals/emacs-gc-stats d2f48f488c 05/24: Update the usage docs, (continued)
- [elpa] externals/emacs-gc-stats d2f48f488c 05/24: Update the usage docs, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats 048af820a7 06/24: emacs-gc-stats-save-session: Smarter repeated session data save, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats 9183a40b15 03/24: Do not use :time keyword in stat data, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats bc6fe1e960 10/24: Record `memory-info' output, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats e06240ad05 14/24: Add license, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats ec9b22d455 15/24: Add README, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats f317944684 19/24: reword README, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats 248ade4f62 04/24: Add `emacs-gc-stats-clear' command, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats fdbb7251b4 07/24: Record init.el stats, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats e64d069950 08/24: Record `memory-info' on init only, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats 30340df54c 18/24: Use Org for README source,
ELPA Syncer <=
- [elpa] externals/emacs-gc-stats 1a8cd5dd08 11/24: Add idle time counter, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats c08135aeaa 12/24: Fix variable name, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats 0725079b75 13/24: Fix linter warnings, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats d27c438dfc 16/24: Fix typo, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats c2c67c16b0 22/24: Add .elpaignore, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats 1fe543c9b6 20/24: README: Link to my email, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats de80c141c6 21/24: * emacs-gc-stats.el: Add maintainer, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats 7a454887a1 02/24: Initial implemention, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats 271ea760fc 09/24: Add some common Emacs distribution indicators, ELPA Syncer, 2023/06/10
- [elpa] externals/emacs-gc-stats b2d59f0ff6 17/24: Reword README, ELPA Syncer, 2023/06/10