]> git.eshelyaron.com Git - emacs.git/commitdiff
Document external maintenance of some packages
authorKarl Fogel <kfogel@red-bean.com>
Mon, 10 Jan 2022 19:20:29 +0000 (13:20 -0600)
committerKarl Fogel <kfogel@red-bean.com>
Mon, 10 Jan 2022 19:20:29 +0000 (13:20 -0600)
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
admin/MAINTAINERS

index 7c3421ed75ab8fb91b081d5e370b92f9a8374e51..614afa27db78b945f25eb5364b41ada6580bc42c 100644 (file)
@@ -366,6 +366,22 @@ 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 sometimes need to deal with that package at its upstream
+source.
+
+In the section "Externally maintained packages" in "admin/MAINTAINERS"
+we maintain a list of such packages.
+
 ** GNU ELPA
 
 This repository does not contain the Emacs Lisp package archive
index c26206baf64d811cdffb37db68bc36c723fce1be..092978f6d2c600a42a94dab500e1620fba6c49b4 100644 (file)
@@ -318,6 +318,23 @@ 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.
+
+       lisp/org/*.el
+       etc/org/*
+       etc/refcards/orgcard.tex
+       doc/misc/org.org
+       doc/misc/org-setup.org
+
 \f
 ;;; Local Variables:
 ;;;   coding: utf-8