[elpa] externals/compat 2f3593ab7f 1/2: Clarify when to load compat-XY.el files

[ELPA Syncer]

branch: externals/compat
commit 2f3593ab7f41ce46cc2dbf40868fcf0b4dbd0cd5
Author: Philip Kaludercic <philipk@posteo.net>
Commit: Philip Kaludercic <philipk@posteo.net>

    Clarify when to load compat-XY.el files
    
    Thanks to Jonas for reporting the discrepancy in this issue:
    https://todo.sr.ht/~pkal/compat/3.
---
 compat-24.el | 10 +++++++++-
 compat-25.el |  5 ++++-
 compat-26.el | 10 +++++++++-
 compat-27.el | 12 +++++++++++-
 compat-28.el | 12 +++++++++++-
 5 files changed, 44 insertions(+), 5 deletions(-)

diff --git a/compat-24.el b/compat-24.el
index a4beccb73f..1d3c18d167 100644
--- a/compat-24.el
+++ b/compat-24.el
@@ -25,7 +25,15 @@
 ;; Find here the functionality added in Emacs 24.4, needed by older
 ;; versions.
 ;;
-;; Do NOT load this library manually.  Instead require `compat'.
+;; Only load this library if you need to use one of the following
+;; functions:
+;;
+;; - `compat-='
+;; - `compat-<'
+;; - `compat->'
+;; - `compat-<='
+;; - `compat->='
+;; - `split-string'.
 
 ;;; Code:
 
diff --git a/compat-25.el b/compat-25.el
index d31b13372a..4f35b9109e 100644
--- a/compat-25.el
+++ b/compat-25.el
@@ -25,7 +25,10 @@
 ;; Find here the functionality added in Emacs 25.1, needed by older
 ;; versions.
 ;;
-;; Do NOT load this library manually.  Instead require `compat'.
+;; Only load this library if you need to use one of the following
+;; functions:
+;;
+;; - `compat-sort'
 
 ;;; Code:
 
diff --git a/compat-26.el b/compat-26.el
index 07ab3a48db..c1d46ddfb3 100644
--- a/compat-26.el
+++ b/compat-26.el
@@ -25,7 +25,15 @@
 ;; Find here the functionality added in Emacs 26.1, needed by older
 ;; versions.
 ;;
-;; Do NOT load this library manually.  Instead require `compat'.
+;; Only load this library if you need to use one of the following
+;; functions:
+;;
+;; - `compat-sort'
+;; - `line-number-at-pos'
+;; - `compat-alist-get'
+;; - `string-trim-left'
+;; - `string-trim-right'
+;; - `string-trim'
 
 ;;; Code:
 
diff --git a/compat-27.el b/compat-27.el
index 29af04036f..f3f74c3819 100644
--- a/compat-27.el
+++ b/compat-27.el
@@ -25,7 +25,17 @@
 ;; Find here the functionality added in Emacs 27.1, needed by older
 ;; versions.
 ;;
-;; Do NOT load this library manually.  Instead require `compat'.
+;; Only load this library if you need to use one of the following
+;; functions or macros:
+;;
+;; - `compat-recenter'
+;; - `compat-lookup-key'
+;; - `compat-setq-local'
+;; - `compat-assoc-delete-all'
+;; - `compat-file-size-human-readable'
+;; - `compat-executable-find'
+;; - `compat-regexp-opt'
+;; - `compat-dired-get-marked-files'
 
 ;;; Code:
 
diff --git a/compat-28.el b/compat-28.el
index e94ac9750e..5a984ddce4 100644
--- a/compat-28.el
+++ b/compat-28.el
@@ -25,7 +25,17 @@
 ;; Find here the functionality added in Emacs 28.1, needed by older
 ;; versions.
 ;;
-;; Do NOT load this library manually.  Instead require `compat'.
+;; Only load this library if you need to use one of the following
+;; functions:
+;;
+;; - `unlock-buffer'
+;; - `string-width'
+;; - `directory-files'
+;; - `json-serialize'
+;; - `json-insert'
+;; - `json-parse-string'
+;; - `json-parse-buffer'
+;; - `count-windows'
 
 ;;; Code: