#3774: Hook order requirements should be documented in manual chapter 5.
----------------------+----------------------
 Reporter:  bernward  |      Owner:  mutt-dev
     Type:  task      |     Status:  new
 Priority:  minor     |  Milestone:
Component:  doc       |    Version:  1.5.21
 Keywords:            |
----------------------+----------------------
 I spent some hours on debugging a configuration problem with save-hook,
 finally I found the solution in http://dev.mutt.org/trac/wiki/DebugConfig:

   Typical problems
     Misunderstanding of how hooks work:
         their order matters and varies by type …
             hooks with filename as result take the first hit exclusively
             (put default as last hook),

 The first place, where I searched for information was the manual.
 So the information from the wiki would help more,
 if it could be found in the manual under chapter 5. "Using Hooks"
         (/usr/share/doc/mutt/html/manual.html#hooks)

 If I go from chapter 5. for specific details on the type save-hook
 to the link save-hook, I find nothing about the order,
 but instead I find this misleading exsample with the default at the first
 place:

         # default: save all to ~/Mail/<author name>
         save-hook . ~/Mail/%F

 Even worse, if I look at the eye-catching note in chapter 5., I see:

         … , a “default” hook needs to be added '''before''' all other
 hooks
         of that type to restore configuration defaults. [emphases by me]


 ----

 '''Solution''', how to help the newbie:

 The information from http://dev.mutt.org/trac/wiki/DebugConfig:

         "their order matters and varies by type"

 should be given in chapter 5. "Using Hooks",
 before the links to specific types of hooks.
 Best would be, if I find also under each link for a type of hook a hint
 like:

         For this type, put default as first|last hook.

-- 
Ticket URL: <http://dev.mutt.org/trac/ticket/3774>
Mutt <http://www.mutt.org/>
The Mutt mail user agent

Reply via email to