[#69] Improvements to Apheleia logging

* Rename apheleia-hide-log-buffer to apheleia-hide-log-buffers.
* Rename apheleia-verbose to apheleia-log-only-errors (note, meaning
  is inverted).
* Add apheleia-hide-old-log-entries.
* Include more information in log and format it more neatly.
* Convert log buffer to special-mode and attempt to keep point at the
  end (although this is not working for an undetermined reason).

1 files changed, 17 insertions, 0 deletions

diff --git a/README.md b/README.md
index be22b9f..23e4d41 100644
--- a/README.md
+++ b/README.md
@@ -169,6 +169,23 @@ run.
 Apheleia does not currently support TRAMP, and is therefore
 automatically disabled for remote files.
 
+You can configure error reporting using the following user options:
+
+* `apheleia-hide-log-buffers`: By default, errors from formatters are
+  put in buffers named like `*apheleia-cmdname-log*`. If you customize
+  this user option to non-nil then a space is prepended to the names
+  of these buffers, hiding them by default in `switch-to-buffer` (you
+  must type a space to see them).
+* `apheleia-log-only-errors`: By default, only failed formatter runs
+  are logged. If you customize this user option to nil then all runs
+  are logged, along with whether or not they succeeded.
+* `apheleia-hide-old-log-entries`: By default, all failed formatter
+  runs are appended to the log. It is intended that point stay at the
+  end of the buffer by default, but due to an unknown bug this is not
+  currently the case. By customizing this user option to non-nil, you
+  can cause only the most recent failure for a formatter to be
+  retained in its log buffer.
+
 The following user options are also available:
 
 * `apheleia-post-format-hook`: Normal hook run after Apheleia formats