From 6a9a0132b7313a16539b2ec8b3fb9cac390b5915 Mon Sep 17 00:00:00 2001 From: Karl Fogel Date: Sun, 9 Jan 2022 16:07:08 -0600 Subject: [PATCH] Document external maintenance of some packages Document the fact that some packages in Emacs are externally maintained, and specifically document Org Mode's external maintenance. 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 | 18 ++++++++++++++++++ admin/MAINTAINERS | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) diff --git CONTRIBUTE CONTRIBUTE index 7c3421ed75..04d0ab00d2 100644 --- CONTRIBUTE +++ CONTRIBUTE @@ -366,6 +366,24 @@ 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 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). + +So when you are making a contribution -- such as fixing a bug or +proposing an enhancement -- to one of these externally maintained +packages, you often need to deal with that package at its upstream +source. + +See section "Externally maintained packages" in "admin/MAINTAINERS" +for a list of such packages. If you discover an externally maintained +package in Emacs that is not yet listed there, please send in a patch +or just let us know. + ** GNU ELPA This repository does not contain the Emacs Lisp package archive diff --git admin/MAINTAINERS admin/MAINTAINERS index e87c3e0204..5b8d73cad7 100644 --- admin/MAINTAINERS +++ admin/MAINTAINERS @@ -316,6 +316,43 @@ Modus themes doc/misc/modus-themes.org etc/themes/modus*.el +Org Mode + Home Page: https://orgmode.org/ + Maintainer: Org Mode developers + Repository: git://git.sv.gnu.org/emacs/org-mode.git + Mailing list: emacs-orgmode@gnu.org + Bug Reports: M-x org-submit-bug-report + Notes: Org Mode is maintained as a separate project that is + periodically merged into Emacs. To view or participate in + Org Mode development, please go to https://orgmode.org/ and + follow the instructions there. + + The source code from the upstream Org Mode project is + usually not identical to the version of Org Mode in Emacs. + The upstream project often has recent changes that have not + yet been merged into Emacs, and Emacs sometimes has local + changes to Org Mode that have not yet been backported to + upstream. https://orgmode.org/worg/org-maintenance.html + documents how the Org Mode project synchronizes changes with + Emacs. + + If you're investigating a bug you encountered in Org Mode in + Emacs, you should obtain the latest upstream code and see if + the bug is present there. If the bug is present, then the + upstream Org Mode project is the proper place to fix it. If + the bug is not present there, that could be because it has + already been fixed upstream, or it could be because the bug + was only introduced on the Emacs side and has not yet been + backported upstream. You will need to figure out what the + situation is in order to know where to contribute your fix. + + lisp/org/*.el + etc/org/* + etc/refcards/orgcard.tex + doc/misc/org.org + doc/misc/org-setup.org + doc/misc/org.texi + ;;; Local Variables: ;;; coding: utf-8 -- 2.34.1