[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/relint 4b78e14 09/16: Add table of contents to README,
From: |
Mattias Engdegård |
Subject: |
[elpa] externals/relint 4b78e14 09/16: Add table of contents to README, and some advice |
Date: |
Mon, 30 Nov 2020 05:00:59 -0500 (EST) |
branch: externals/relint
commit 4b78e144230cd44b072bcb44ba911d0d01e4b21b
Author: Mattias Engdegård <mattiase@acm.org>
Commit: Mattias Engdegård <mattiase@acm.org>
Add table of contents to README, and some advice
---
README | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/README b/README
index 0f042ad..5a987a2 100644
--- a/README
+++ b/README
@@ -6,6 +6,16 @@ syntax and bad practice. It also checks the regexp-like
arguments to
skip-chars-forward, skip-chars-backward, skip-syntax-forward and
skip-syntax-backward.
+* Contents
+
+ - Usage
+ - Installation
+ - What the diagnostics mean
+ - Suppressing diagnostics
+ - How it works
+ - Bugs
+
+
* Usage
- Check a single file:
@@ -49,6 +59,9 @@ skip-syntax-backward.
* What the diagnostics mean
+ Tip: if a regexp string is difficult to understand, consider
+ decoding it using 'xr', as in (xr-lint "gibberish").
+
- Unescaped literal 'X'
A special character is taken literally because it occurs in a
- [elpa] externals/relint updated (0c35e02 -> 26639c5), Mattias Engdegård, 2020/11/30
- [elpa] externals/relint a1ea26c 01/16: Check regexp arguments to more functions, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint d0fa8a8 10/16: Fix false positives in regexp provenance checks, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint 29e5427 11/16: Recognise a few more `featurep` arguments, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint 26639c5 16/16: Require xr 1.20, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint 7690e3a 08/16: Scan font-lock-defaults correctly, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint 4b78e14 09/16: Add table of contents to README, and some advice,
Mattias Engdegård <=
- [elpa] externals/relint c792bde 15/16: Perform Emacs version check at compile time, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint c8fd922 12/16: Minor looking-at optimisation, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint 5720e12 07/16: Scan regexp arguments to functions in s.el, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint f0241bc 13/16: Increment version to 1.19, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint 9173a91 05/16: Add progress indicator for interactive relint-directory, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint 5572c57 14/16: Emacs 26 compatibility: `directory-files-recursively`, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint 1c66438 06/16: Add string-search and string-replace to the list of pure functions, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint b572fcd 02/16: Run automatic tests on Emacs 27.1, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint 14a5135 03/16: Minor README correction, Mattias Engdegård, 2020/11/30
- [elpa] externals/relint 8ee9f79 04/16: Avoid descending into .git/ when looking for .el files, Mattias Engdegård, 2020/11/30