unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: "Sławomir Grochowski" <slawomir.grochowski@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: living documentation - list packages in core
Date: Sun, 03 Mar 2024 08:24:34 +0200	[thread overview]
Message-ID: <861q8rq1ct.fsf@gnu.org> (raw)
In-Reply-To: <87jzmk1gsr.fsf@gmail.com> (message from Sławomir Grochowski on Sat, 02 Mar 2024 22:10:12 +0100)

> From: Sławomir Grochowski <slawomir.grochowski@gmail.com>
> Date: Sat, 02 Mar 2024 22:10:12 +0100
> 
> In the Emacs codebase, there are numerous packages with overlaps and
> interactions that I don’t fully understand. Therefore, I have generated
> a table listing all packages along with their functionalities to
> provide an overall view.
> 
> Information extracted from each file includes:
> 
> 1. Name of the file/package
> 2. Year of creation - determined from the first date in the line ';; Copyright (C)'
> 3. Autoload - indicates whether the package is preloaded. Note that some packages are preloaded without autoload, for example, abbrev.el
> 4. Keywords - extracted from the line ';; Keywords:'
> 5. Description - taken from the first line, e.g., ';;; ibuffer.el --- operate on buffers like dired'

We have finder.el which does this job (it doesn't extract the year and
the preloaded parts, but this is either not very important IMO or
available by other means).  The only difference is that finder.el is
by default run only when Emacs is built, so the data is static once
Emacs is installed.  But then core packages are seldom modified
without rebuilding Emacs, so for those packages doing it as part of
the build seems justified.  You can see the result of running
finder.el in the file finder-inf.el which is present in any built
Emacs tree.

Maybe we could extend finder.el to provide additional information and
to scan more directories, so that, for example, it covers installed
packages in ~/.emacs.d/ etc.  I think this is a better way forward
than inventing a completely new facility for what seems like a very
similar purpose.

Thanks.



      reply	other threads:[~2024-03-03  6:24 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-02 21:10 living documentation - list packages in core Sławomir Grochowski
2024-03-03  6:24 ` Eli Zaretskii [this message]

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=861q8rq1ct.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=slawomir.grochowski@gmail.com \
    /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 public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).