diff --git a/README b/README index b0bb6fc67d..5952a007d0 100644 --- a/README +++ b/README @@ -1,5 +1,5 @@ #+TITLE: GNU ELPA README -#+DATE: 2022-06-05 +#+DATE: 2022-10-26 Copyright (C) 2010-2022 Free Software Foundation, Inc. \\ See the end of the file for license conditions. @@ -7,7 +7,7 @@ See the end of the file for license conditions. #+BEGIN_COMMENT This file exists in two branches ~elpa-admin~ and ~elpa~. The two version differ slightly. The introductory text before the first heading -differs and their are minor differences concerning the ~externals/*~ to +differs and there are minor differences concerning the ~externals/*~ to ~elpa/*~ transition. Please make sure you always update this file in both locations to avoid introducing additional differences. This duplication will be removed eventually. @@ -158,6 +158,14 @@ and only if the version number in the development branch indicates that it contains development code (i.e. a "snapshot" version, according to `version-to-list`). +If there is no upstream (:url is nil), the presence of :release-branch +just indicates that release and devel branches in elpa.git are desired +(the name given in :release-branch is ignored). The release branch is +named `externals-release/' for GNU ELPA and +`elpa-release/` for NonGNU ELPA. The standard package branch +externals/ is the devel branch in GNU ELPA; the standard +branch elpa/ is the devel branch in non-GNU ELPA. + ** =:ignored-files FILES= Names of files or directories that should not be included in the tarballs. @@ -171,7 +179,8 @@ having to specify it here. ** =:readme FILE= Name of the file to use as the description of the package. By default we try to use README, README.rst, README.org, or the Commentary section -in the main file. +in the main file. If ~ignore~, ignore any matching file and use the Commentary +section. ** =:news FILE= Name of the file that contains the list of changes in recent versions @@ -287,7 +296,6 @@ Delete all the files generated by =make packages/[PKGNAME]=. * Packages ** Contents of the =packages/= directory: - This directory holds the package sources, with one subdirectory for each package. @@ -414,7 +422,7 @@ and the web-pages from this source code: auto-generated from it. - Every package should have both a =Version:= /and/ a =Maintainer:=. - The =Version:= must be acceptable to =version-to-list=. -- The =URL:= header can be used to specify the website +- The =URL:= header can be used to specify the home page of the package, if it's maintained externally. - A =News:= section (or "NEWS" file) can/should be used to list the user-visible changes of each version.