File: bug-reference.el.html
This file provides minor modes for putting clickable overlays on
references to bugs. A bug reference is text like "PR foo/29292";
this is mapped to a URL using a user-supplied format; see
bug-reference-url-format and bug-reference-bug-regexp. More
extensive documentation is in (info "(emacs) Bug Reference").
Two minor modes are provided. One works on any text in the buffer; the other operates only on comments and strings. By default, the URL link is followed by invoking C-c RET or mouse-2.
Defined variables (13)
bug-reference--setup-from-vc-alist | An alist for setting up ‘bug-reference-mode’ based on VC URL. |
bug-reference-auto-setup-functions | Functions trying to auto-setup ‘bug-reference-mode’. |
bug-reference-bug-regexp | Regular expression matching bug references. |
bug-reference-forge-alist | An alist of forge instances. |
bug-reference-map | Keymap used by bug reference buttons. |
bug-reference-mode | Non-nil if Bug-Reference mode is enabled. |
bug-reference-mode-hook | Hook run after entering or leaving ‘bug-reference-mode’. |
bug-reference-prog-mode | Non-nil if Bug-Reference-Prog mode is enabled. |
bug-reference-prog-mode-hook | Hook run after entering or leaving ‘bug-reference-prog-mode’. |
bug-reference-setup-from-irc-alist | An alist for setting up ‘bug-reference-mode’ in IRC modes. |
bug-reference-setup-from-mail-alist | An alist for setting up ‘bug-reference-mode’ in mail modes. |
bug-reference-setup-from-vc-alist | An alist for setting up ‘bug-reference-mode’ based on VC URL. |
bug-reference-url-format | Format used to turn a bug number into a URL. |
Defined functions (18)
bug-reference--build-forge-setup-entry | (HOST-DOMAIN FORGE-TYPE PROTOCOL) |
bug-reference--overlays-in | (START END) |
bug-reference--setup-from-vc-alist | (&optional REBUILD) |
bug-reference-fontify | (START END) |
bug-reference-maybe-setup-from-irc | (CHANNEL NETWORK) |
bug-reference-maybe-setup-from-mail | (GROUP HEADER-VALUES) |
bug-reference-maybe-setup-from-vc | (URL URL-RX BUG-RX BUG-URL-FMT) |
bug-reference-mode | (&optional ARG) |
bug-reference-mode-force-auto-setup | () |
bug-reference-prog-mode | (&optional ARG) |
bug-reference-push-button | (&optional POS USE-MOUSE-ACTION) |
bug-reference-set-overlay-properties | () |
bug-reference-try-setup-from-erc | () |
bug-reference-try-setup-from-gnus | () |
bug-reference-try-setup-from-rcirc | () |
bug-reference-try-setup-from-rmail | () |
bug-reference-try-setup-from-vc | () |
bug-reference-unfontify | (START END) |