all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Kangas <stefan@marxist.se>
Cc: 44748@debbugs.gnu.org, monnier@iro.umontreal.ca
Subject: bug#44748: [PATCH] New section on package initialization; document quickstart
Date: Fri, 20 Nov 2020 09:58:33 +0200	[thread overview]
Message-ID: <834klk1mty.fsf@gnu.org> (raw)
In-Reply-To: <CADwFkm=eiWrG8bkts-HPPgv3PPFz61S9kzRzfzaHvzAfDG_8xg@mail.gmail.com> (message from Stefan Kangas on Thu, 19 Nov 2020 17:00:18 -0800)

> From: Stefan Kangas <stefan@marxist.se>
> Date: Thu, 19 Nov 2020 17:00:18 -0800
> Cc: monnier@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.





  reply	other threads:[~2020-11-20  7:58 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-20  1:00 bug#44748: [PATCH] New section on package initialization; document quickstart Stefan Kangas
2020-11-20  7:58 ` Eli Zaretskii [this message]
2021-05-13 11:46   ` Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=834klk1mty.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=44748@debbugs.gnu.org \
    --cc=monnier@iro.umontreal.ca \
    --cc=stefan@marxist.se \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.