branch: externals/advice-patch
commit 2990c6647ffe1c188b84ade4da0314d2d9430437
Author: Stefan Monnier <monn...@iro.umontreal.ca>
Commit: Stefan Monnier <monn...@iro.umontreal.ca>
Improve the `Commentary:`
---
advice-patch.el | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/advice-patch.el b/advice-patch.el
index df0e2f5..cfc7265 100644
--- a/advice-patch.el
+++ b/advice-patch.el
@@ -1,6 +1,6 @@
;;; advice-patch.el --- Use patches to advise the inside of functions -*-
lexical-binding: t; -*-
-;; Copyright (C) 2019 Free Software Foundation, Inc.
+;; Copyright (C) 2019-2020 Free Software Foundation, Inc.
;; Author: Stefan Monnier <monn...@iro.umontreal.ca>
;; Package-requires: ((emacs "24.4"))
@@ -34,6 +34,17 @@
;; Beware: this can eat your lunch and can misbehave unexpectedly in many
;; legitimate cases.
+;; Use it is as follows:
+;;
+;; (advice-patch 'foo (my new code)
+;; [(some old code)
+;; (some (other version) (of the old) code))])
+;;
+;; This will fetch the source code of `foo', look for an occurrence
+;; of one of the old code chunks listed, replace it with
+;; `(my new code)', compile the result, and finally ask `advice-add' to use it
+;; to override the original definition.
+
;;;; TODO:
;; - Lots of cases to fix and features to add. See FIXMEs in the code.
