diff options
| author |   Ulrich Müller <ulm@gentoo.org> | 2024-10-05 19:54:13 +0200 |
|---|---|---|
| committer | Ulrich Müller <ulm@gentoo.org> | 2024-10-05 19:54:13 +0200 |
| commit | 491204e6779f227f959d7e83a62d43998f6a89d3 (patch) | |
| tree | a3e5be2eb16a5d111e18a6e6366e1df679c69601 | |
| parent | Update the condition for enabling bug-reference (diff) | |
| download | ebuild-mode-491204e6779f227f959d7e83a62d43998f6a89d3.tar.gz ebuild-mode-491204e6779f227f959d7e83a62d43998f6a89d3.tar.bz2 ebuild-mode-491204e6779f227f959d7e83a62d43998f6a89d3.zip | |
Update documentation
* ebuild-mode.texi (ebuild-repo-mode): Document the bug-reference
feature.
(devbook-mode): Add cross reference to the nXML Mode manual.
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
| -rw-r--r-- | ChangeLog | 4 | ||||
| -rw-r--r-- | ebuild-mode.texi | 18 |
2 files changed, 20 insertions, 2 deletions
@@ -1,5 +1,9 @@ 2024-10-05 Ulrich Müller <ulm@gentoo.org> + * ebuild-mode.texi (ebuild-repo-mode): Document the bug-reference + feature. + (devbook-mode): Add cross reference to the nXML Mode manual. + * ebuild-mode.el (ebuild-repo-mode): Don't set the bug-reference-* variables if ebuild-mode-enable-bug-reference is nil. Test for bug-reference-prog-mode at run time instead of compile time. diff --git a/ebuild-mode.texi b/ebuild-mode.texi index 6d810cd..7c8cf36 100644 --- a/ebuild-mode.texi +++ b/ebuild-mode.texi @@ -255,13 +255,27 @@ is commonly used in @file{package.mask} and other files: The user's name and e-mail address can be customized with variables @code{ebuild-mode-full-name} and @code{ebuild-mode-mail-address}. +By default, @code{ebuild-repo-mode} will enable +@code{bug-reference-prog-mode}. This highlights references to bug +reports and makes it possible to follow them to the Gentoo bug tracker +(typically by pressing @kbd{C-c RET} or clicking @kbd{mouse-2} on the +highlighted text). For example, the reference @samp{bug #161121} in a +comment line would link to @url{https://bugs.gentoo.org/161121}. + +@xref{Bug Reference,,, emacs, The Emacs Editor} for further +explanation. + +You can disable bug references by setting the custom variable +@code{ebuild-mode-enable-bug-reference} to nil. + @node devbook-mode, gentoo-newsitem-mode, ebuild-eclass-mode, Top @chapter devbook-mode for the Gentoo Devmanual This is a very simple derived major mode for editing the Devmanual. Because the Devmanual is written in DevBook XML, this mode is derived from @code{nxml-mode} and inherits its syntax highlighting and editing -functions. A skeleton for a new Devmanual file can be inserted via -the @code{devbook-insert-skeleton} function bound to @kbd{C-c C-n}. +functions (@pxref{Top,,, nxml-mode, nXML Mode}). A skeleton for a new +Devmanual file can be inserted via the @code{devbook-insert-skeleton} +function bound to @kbd{C-c C-n}. It is recommended to install the @code{app-emacs/nxml-gentoo-schemas} package in addition, which will enable on-the-fly syntax validation. |