GNU bug report logs -
#66350
30.0.50; Description for (use-package emacs ...)
Previous Next
Reported by: Arash Esbati <arash <at> gnu.org>
Date: Wed, 4 Oct 2023 21:32:02 UTC
Severity: wishlist
Found in version 30.0.50
Fixed in version 30.1
Done: Stefan Kangas <stefankangas <at> gmail.com>
Bug is archived. No further changes may be made.
Full log
View this message in rfc822 format
[Message part 1 (text/plain, inline)]
Your bug report
#66350: 30.0.50; Description for (use-package emacs ...)
which was filed against the emacs package, has been closed.
The explanation is attached below, along with your original report.
If you require more details, please reply to 66350 <at> debbugs.gnu.org.
--
66350: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=66350
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
[Message part 3 (text/plain, inline)]
Version: 30.1
Arash Esbati <arash <at> gnu.org> writes:
> Thanks. In order to close this report, I suggest to add the following
> to the manual:
>
> --8<---------------cut here---------------start------------->8---
> diff --git a/doc/misc/use-package.texi b/doc/misc/use-package.texi
> index c2b6404b68b..e0a156eb373 100644
> --- a/doc/misc/use-package.texi
> +++ b/doc/misc/use-package.texi
> @@ -181,7 +181,7 @@ Getting Started
> immediately. In most cases, this is not necessary or desirable, as
> that will slow down Emacs startup. Instead, you should try to set
> things up so that packages are only loaded when they are actually
> -needed (a.k.a. ``autoloading''). If you have installed a package from
> +needed (a.k.a.@: ``autoloading''). If you have installed a package from
> @acronym{GNU} @acronym{ELPA} that provides it's own autoloads, it is often
> enough to say:
>
> @@ -225,6 +225,21 @@ Getting Started
> that you can use. Where possible, it is a good idea to copy them, and
> use that as a starting point.
>
> +You can also configure variables defined in Emacs C sources or preloaded
> +with Emacs with the no-op @samp{emacs} package:
> +
> +@lisp
> +@group
> +(use-package emacs
> + :init
> + (setq custom-file "~/.emacs.d/emacs-custom.el")
> + (load custom-file)
> + (setq frame-title-format "%b")
> + :custom
> + (use-short-answers t))
> +@end group
> +@end lisp
> +
> That should be enough to get you started!
>
> @c ----------------------------------------------------------------------------
> --8<---------------cut here---------------end--------------->8---
>
> If the question is too trivial, we can close it as wontfix.
I've installed the attached patch on emacs-30 (commit c7609464f70),
adding a new node describing this all. Thanks for proposing a text, it
was a useful starting point.
Please let me know if you spot any mistakes or anything that could be
improved in what I wrote. Meanwhile, I'm closing this bug report.
[0001-Document-use-package-emacs-declarations.patch (text/x-patch, attachment)]
[Message part 5 (message/rfc822, inline)]
Hi all,
use-package.texi contains this example[1]:
@lisp
@group
;; Completely hide visual-line-mode and change auto-fill-mode to " AF".
(use-package emacs
:delight
(auto-fill-function " AF")
(visual-line-mode))
@end group
@end lisp
The usage of (use-package emacs ...) isn't described anywhere in the
file, though. There was a discussion about it here[2], but I think it
should be documented in the manual somehow. I'm not familiar enough
with use-package to make a suggestion, sorry.
Best, Arash
Footnotes:
[1] https://git.savannah.gnu.org/cgit/emacs.git/tree/doc/misc/use-package.texi#n1539
[2] https://www.reddit.com/r/emacs/comments/mk9ehd/curious_whats_the_use_of_usepackage_emacs/
This bug report was last modified 299 days ago.
Previous Next
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.