GNU bug report logs - #44748
[PATCH] New section on package initialization; document quickstart

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 44748 in the body.
You can then email your comments to 44748 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] New section on package initialization; document quickstart
Date: Thu, 19 Nov 2020 17:00:18 -0800

[Message part 1 (text/plain, inline)]

Severity: wishlist

Please find attached a patch to add a new section on package
initialization to the user manual, and to document package-quickstart.

Thoughts?

[0001-New-section-on-package-initialization-document-quick.patch (text/x-diff, attachment)]

Message #8 received at 44748 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 44748 <at> debbugs.gnu.org, monnier <at> iro.umontreal.ca
Subject: Re: bug#44748: [PATCH] New section on package initialization;
 document quickstart
Date: Fri, 20 Nov 2020 09:58:33 +0200

> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Thu, 19 Nov 2020 17:00:18 -0800
> Cc: monnier <at> iro.umontreal.ca
> 
> Please find attached a patch to add a new section on package
> initialization to the user manual, and to document package-quickstart.
> 
> Thoughts?

Does adding 2 short paragraphs justify yet another node?  The original
text is 125 lines long, not too long IMO.

> diff --git a/doc/emacs/package.texi b/doc/emacs/package.texi
> index 4981dd50c7..3e9be39475 100644
> --- a/doc/emacs/package.texi
> +++ b/doc/emacs/package.texi
> @@ -48,6 +48,7 @@ Packages
>  * Package Menu::         Buffer for viewing and managing packages.
>  * Package Statuses::     Which statuses a package can have.
>  * Package Installation:: Options for package installation.
> +* Package Initialization:: How packages are initialized.
>  * Package Files::        Where packages are installed.
>  @end menu

When you add nodes, you need to update the detailed menu in emacs.texi
as well.

> +@findex package-quickstart-refresh
> +@vindex package-quickstart
> +  If you have many packages installed, you can improve startup times
> +by setting the user option @code{package-quickstart} to @code{t}.
> +This requires you to manually run the command
> +@code{package-quickstart-refresh} when the activations need to be
> +changed, such as when you change the value of
> +@code{package-load-list}.

This text doesn't explain what the quick start does.  Perhaps saying
what will happen if the user forgets to manually run that command
(error messages? signs of incorrect behavior?) would suffice.
Otherwise this text sounds like some black magic, and that is not a
good thing for a user manual.

Thanks.

Message #11 received at 44748 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 44748 <at> debbugs.gnu.org, Stefan Kangas <stefan <at> marxist.se>,
 monnier <at> iro.umontreal.ca
Subject: Re: bug#44748: [PATCH] New section on package initialization;
 document quickstart
Date: Thu, 13 May 2021 13:46:30 +0200

Documenting package-quickstart seems like a good idea, so I've partially
applied Stefan's patch.  But I agree with Eli that we don't need a new
section here, so I removed that bit, and I expanded a bit upon what
package-quickstart does.

Feel free to edit further if it's still unclear.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.