magit-popup.org: document how to change popup properties

2 files changed, 27 insertions, 0 deletions

diff --git a/Documentation/magit-popup.org b/Documentation/magit-popup.org
index b5c430d..17e4d36 100644
--- a/Documentation/magit-popup.org
+++ b/Documentation/magit-popup.org
@@ -299,6 +299,15 @@ commands to an existing popup using the following functions.
   defined using ~magit-define-popup~.  TYPE is one of ~:action~, ~:switch~,
   or ~:option~.  KEY is the character which is to be unbound.
 
+It is also possible to change other aspects of a popup by setting a
+property using ~plist-put~.  See [[*Defining prefix commands]] for valid
+properties.  The most likely change Magit users might want to make
+is:
+
+#+BEGIN_SRC emacs-lisp
+  (plist-put magit-show-refs-popup :use-prefix nil)
+#+END_SRC
+
 ** Other options
 
 - User Option: magit-popup-use-prefix-argument
@@ -330,6 +339,11 @@ commands to an existing popup using the following functions.
 
     Ignore prefix arguments.
 
+  This option can be overriden for individual popups.
+  ~magit-show-refs-popup~ for example default to invoking the default
+  action directly.  It only shows the popup buffer when a prefix
+  argument is used.  See [[*Customizing existing popups][Customizing existing popups]].
+
 - User Option: magit-popup-manpage-package
 
   The Emacs package used to display man-pages, one of ~man~ or ~woman~.
diff --git a/Documentation/magit-popup.texi b/Documentation/magit-popup.texi
index 4a57593..d00472d 100644
--- a/Documentation/magit-popup.texi
+++ b/Documentation/magit-popup.texi
@@ -374,6 +374,15 @@ defined using @code{magit-define-popup}.  TYPE is one of @code{:action}, @code{:
 or @code{:option}.  KEY is the character which is to be unbound.
 @end defun
 
+It is also possible to change other aspects of a popup by setting a
+property using @code{plist-put}.  See @ref{Defining prefix commands,Defining prefix commands} for valid
+properties.  The most likely change Magit users might want to make
+is:
+
+@lisp
+(plist-put magit-show-refs-popup :use-prefix nil)
+@end lisp
+
 @node Other options
 @section Other options
 
@@ -414,6 +423,10 @@ directly invoke the popup's default action.
 
 Ignore prefix arguments.
 @end itemize
+This option can be overriden for individual popups.
+@code{magit-show-refs-popup} for example default to invoking the default
+action directly.  It only shows the popup buffer when a prefix
+argument is used.  See @ref{Customizing existing popups,Customizing existing popups}.
 @end defopt
 
 @defopt magit-popup-manpage-package