From: Karl Fogel <kfogel@red-bean.com>
To: emacs-devel@gnu.org
Cc: Eli Zaretskii <eliz@gnu.org>
Subject: Re: Improving documentation of Org Mode integration into Emacs.
Date: Sun, 02 Jan 2022 23:05:05 -0600 [thread overview]
Message-ID: <87fsq5tnni.fsf@red-bean.com> (raw)
In-Reply-To: <834k7n5zfu.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 05 Dec 2021 08:38:13 +0200")
[-- Attachment #1: Type: text/plain, Size: 1639 bytes --]
On 05 Dec 2021, Eli Zaretskii wrote:
>> I'd like to improve our in-tree documentation of how Org Mode
>> integration into GNU Emacs works.
>
>Thanks. Can you provide a rough sketch, in the form of list of
>items,
>of what you'd like to document, and who would be the main
>audience for
>that? I don't have a clear idea of that based on what you
>posted.
Sure. (The attached patch may answer your questions more
efficiently, though.)
* Audience:
The audience is Emacs developers and potential developers who are
tracking down bugs, or trying to contribute enhancements, but who
don't know that certain packages (such as Org Mode) are externally
maintained.
It's better for us all if such a person finds out as soon as
possible where the active upstream for a package is. For example,
if they've found a bug in Org Mode, they should take the bug
report to the Org Mode forums and discuss it with the Org Mode
maintainers. (Maybe sometimes Emacs Devel should also be
involved, but the person should at least start out in the proper
upstream forum and then be guided appropriately from there.)
* List of items:
All the packages that ship as part of Emacs but that are
externally maintained. Right now, Org Mode is the only one I know
of, but I suspect there are others. If people would like to point
others out to me, I'll update the attached patch to include them
too.
The attached patch is an attempt to document this situation in
such a way that developers are likely to encounter the
documentation when they most need it. Comments welcome; I'm
certainly open to other strategies.
Best regards,
-Karl
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: [PATCH] Document external maintenance of some packages --]
[-- Type: text/x-diff, Size: 2490 bytes --]
From b709de6a9ffb4cbb30b480f97f1de009a00769a9 Mon Sep 17 00:00:00 2001
From: Karl Fogel <kfogel@red-bean.com>
Date: Sun, 2 Jan 2022 22:49:35 -0600
Subject: [PATCH] Document external maintenance of some packages
Document the fact that some packages in Emacs are externally
maintained, and document Org Mode's provenance specifically.
For more context, see the thread that starts here:
https://lists.gnu.org/archive/html/emacs-devel/2021-12/msg00366.html
From: Karl Fogel
To: Emacs Devel
Subject: Improving documentation of Org Mode integration into Emacs.
Date: Sat, 04 Dec 2021 15:14:59 -0600
Message-ID: <87zgpgax7w.fsf@red-bean.com>
---
CONTRIBUTE | 17 +++++++++++++++++
lisp/org/README | 6 ++++++
2 files changed, 23 insertions(+)
create mode 100644 lisp/org/README
diff --git CONTRIBUTE CONTRIBUTE
index 7c3421ed75..6f3bb9bf32 100644
--- CONTRIBUTE
+++ CONTRIBUTE
@@ -366,6 +366,23 @@ reasons. These should be marked by including something like "Do not
merge to master" or anything that matches gitmerge-skip-regexp (see
admin/gitmerge.el) in the commit message.
+** Some packages in Emacs are maintained externally
+
+Sometimes a package that ships as part of GNU Emacs is actually
+maintained as a separate project, with its own upstream repository,
+its own maintainer group, its own development conventions, etc. The
+upstream project's code is periodically merged into Emacs -- exactly
+when and how such merges happen depends on the package.
+
+Each externally maintained package lives in its own subdirectory in
+the Emacs tree, and that subdirectory should have a "README" file that
+describes the upstream origin. For example, "lisp/org/README" says
+where the Org Mode project lives and how it's synchronized into Emacs.
+
+Note that not all the independently-maintained packages in Emacs have
+such a "README" yet. If you know of one that's missing its "README",
+please send in a patch or just let us know.
+
** GNU ELPA
This repository does not contain the Emacs Lisp package archive
diff --git lisp/org/README lisp/org/README
new file mode 100644
index 0000000000..f9fe1e6edc
--- /dev/null
+++ lisp/org/README
@@ -0,0 +1,6 @@
+Org Mode is maintained as a separate project, and is periodically
+merged into Emacs.
+
+See https://orgmode.org/ for more information, and see specifically
+https://orgmode.org/worg/org-maintenance.html for information about
+the process of synchronization between upstream Org Mode and Emacs.
--
2.34.1
next prev parent reply other threads:[~2022-01-03 5:05 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-04 21:14 Improving documentation of Org Mode integration into Emacs Karl Fogel
2021-12-04 21:18 ` Karl Fogel
2021-12-04 22:09 ` [External] : " Drew Adams
2021-12-05 5:16 ` Stefan Monnier
2021-12-05 6:38 ` Eli Zaretskii
2022-01-03 5:05 ` Karl Fogel [this message]
2022-01-03 5:44 ` Stefan Monnier
2022-01-05 3:09 ` Karl Fogel
2022-01-05 13:48 ` Eli Zaretskii
2022-01-05 14:17 ` Michael Albinus
2022-01-05 14:26 ` Eli Zaretskii
2022-01-06 12:40 ` Michael Albinus
2022-01-06 13:58 ` Eli Zaretskii
2022-01-07 10:41 ` Protesilaos Stavrou
2022-01-09 22:34 ` Karl Fogel
2022-01-10 8:46 ` Michael Albinus
2022-01-10 9:03 ` Michael Albinus
2022-01-10 9:13 ` Karl Fogel
2022-01-10 9:17 ` Michael Albinus
2022-01-10 11:01 ` Robert Pluim
2022-01-10 16:10 ` Karl Fogel
2022-01-10 9:06 ` Karl Fogel
2022-01-10 9:24 ` Michael Albinus
2022-01-10 16:20 ` Karl Fogel
2022-01-10 18:24 ` Eli Zaretskii
2022-01-11 7:49 ` Michael Albinus
2022-01-10 18:14 ` Eli Zaretskii
2022-01-10 19:08 ` Karl Fogel
2022-01-03 8:52 ` Michael Albinus
2022-01-03 12:06 ` Protesilaos Stavrou
2022-01-03 13:31 ` Eli Zaretskii
2022-01-03 20:45 ` Rudolf Adamkovič
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=87fsq5tnni.fsf@red-bean.com \
--to=kfogel@red-bean.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
/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).