From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stephen Leake Newsgroups: gmane.emacs.devel Subject: ELPA notes, README Date: Sun, 10 Jan 2021 15:05:18 -0800 Message-ID: <86wnwks89d.fsf_-_@stephe-leake.org> References: <86a6ugnopl.fsf@stephe-leake.org> <83im94b17m.fsf@gnu.org> <834kknatxs.fsf@gnu.org> <83r1nqaph6.fsf@gnu.org> <83eejqak4s.fsf@gnu.org> <867dphmt73.fsf@stephe-leake.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16435"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.1 (windows-nt) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Jan 11 00:06:39 2021 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1kyjnC-00049l-IK for ged-emacs-devel@m.gmane-mx.org; Mon, 11 Jan 2021 00:06:38 +0100 Original-Received: from localhost ([::1]:39152 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kyjnB-0001Y1-IP for ged-emacs-devel@m.gmane-mx.org; Sun, 10 Jan 2021 18:06:37 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37668) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kyjm2-0000vJ-39 for emacs-devel@gnu.org; Sun, 10 Jan 2021 18:05:26 -0500 Original-Received: from gateway30.websitewelcome.com ([192.185.194.16]:40836) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kyjly-0005aw-KJ for emacs-devel@gnu.org; Sun, 10 Jan 2021 18:05:24 -0500 Original-Received: from cm13.websitewelcome.com (cm13.websitewelcome.com [100.42.49.6]) by gateway30.websitewelcome.com (Postfix) with ESMTP id 8FB1F34EB for ; Sun, 10 Jan 2021 17:05:18 -0600 (CST) Original-Received: from host2007.hostmonster.com ([67.20.76.71]) by cmsmtp with SMTP id yjlukDmneoE4DyjlukVNFL; Sun, 10 Jan 2021 17:05:18 -0600 X-Authority-Reason: nr=8 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=stephe-leake.org; s=default; h=Content-Type:MIME-Version:Message-ID: In-Reply-To:Date:References:Subject:To:From:Sender:Reply-To:Cc: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=BiQbCK7hTxU0e/N4QGkuVGuBsHlHT/hOStgMkbobHv0=; b=cZHPOfpV9nr/6mm51qyuz8jU/ wWZJBkUCVAiKir/48GPs32rnApVzYLas5hK52cSszJNzHtHuS4t9VJUCyITDKWgvHcNs8L/Oahtc+ uD59WWzxGy3yuMmOhr2lixKYdcAtAMsQL5biid5hLkA7kx8I3ABucDciVa4AiaSMWJKu7RDM0yX6k tkC9BNATo96ICswFL1wFCiD6dRlAZcB1oKCest8I/TkeNNYZJq/KmxctykB2h4huO+MU/9s3XMG6D 1TWRaqD1HtJJxCxLcnZngrubi0IMi2y0BtN7Gv+pwUkxWxzpz6UDW6OOFS3Gugyu74bNiTcfkMLvv EDG+rhbWQ==; Original-Received: from [76.77.182.20] (port=53194 helo=Takver4) by host2007.hostmonster.com with esmtpsa (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.93) (envelope-from ) id 1kyjlt-003UYS-Uk for emacs-devel@gnu.org; Sun, 10 Jan 2021 16:05:18 -0700 In-Reply-To: <867dphmt73.fsf@stephe-leake.org> (Stephen Leake's message of "Wed, 16 Dec 2020 11:44:48 -0800") X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - host2007.hostmonster.com X-AntiAbuse: Original Domain - gnu.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - stephe-leake.org X-BWhitelist: no X-Source-IP: 76.77.182.20 X-Source-L: No X-Exim-ID: 1kyjlt-003UYS-Uk X-Source-Sender: (Takver4) [76.77.182.20]:53194 X-Source-Auth: stephen_leake@stephe-leake.org X-Email-Count: 1 X-Source-Cap: c3RlcGhlbGU7c3RlcGhlbGU7aG9zdDIwMDcuaG9zdG1vbnN0ZXIuY29t X-Local-Domain: yes Received-SPF: neutral client-ip=192.185.194.16; envelope-from=stephen_leake@stephe-leake.org; helo=gateway30.websitewelcome.com X-Spam_score_int: -8 X-Spam_score: -0.9 X-Spam_bar: / X-Spam_report: (-0.9 / 5.0 requ) BAYES_00=-1.9, DKIM_INVALID=0.1, DKIM_SIGNED=0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_PASS=-0.001, SPF_NEUTRAL=0.779 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:262885 Archived-At: --=-=-= Content-Type: text/plain I'm starting to work on documenting how to bundle Gnu ELPA packages in the Emacs distribution tarball. As a first step, I checked out the current documentation, and I have some suggested improvements even without the bundling option. In Emacs admin/notes/elpa: see attached elpa_notes.diff. This reflects recent changes to elpa. In ELPA README: see attached elpa_readme.diff. This moves 'make packages/' to the "getting the source" section, and documents the need for 'make setup'. Ok to commit? Next step: I'll go thru the recent thread and compile the policy and process info into emacs/admin/notes/elpa (without committing anything). -- -- Stephe --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=notes_elpa.diff diff --git a/admin/notes/elpa b/admin/notes/elpa index ea6c132fe1..1e9e7a9f52 100644 --- a/admin/notes/elpa +++ b/admin/notes/elpa @@ -5,17 +5,31 @@ repository named "elpa", hosted on Savannah. To check it out: git clone git://git.sv.gnu.org/emacs/elpa cd elpa - git remote set-url --push origin git+ssh://git.sv.gnu.org/srv/git/emacs/elpa - [create task branch for edits, etc.] + make setup -Changes to this branch propagate to elpa.gnu.org via a "deployment" script run -daily. This script (which is kept in elpa/admin/update-archive.sh) generates -the content visible at https://elpa.gnu.org/packages. +That leaves the elpa/packages directory empty; you must check out the +ones you want. -A new package is released as soon as the "version number" of that package is -changed. So you can use 'elpa' to work on a package without fear of releasing -those changes prematurely. And once the code is ready, just bump the -version number to make a new release of the package. +If you wish to check out all the packages into the packages directory, +you can run the command: + + make worktrees + +You can check out a specific package into the packages +directory with: + + make packages/ + + +Changes to this repository propagate to elpa.gnu.org via a +"deployment" script run daily. This script generates the content +visible at https://elpa.gnu.org/packages. + +A new package is released as soon as the "version number" of that +package is changed. So you can use 'elpa' to work on a package +without fear of releasing those changes prematurely. And once the +code is ready, just bump the version number to make a new release of +the package. It is easy to use the elpa branch to deploy a "local" copy of the package archive. For details, see the README file in the elpa branch. --=-=-= Content-Type: text/x-patch Content-Disposition: inline; filename=elpa_readme.diff diff --git a/README b/README index d6114a852c..9e77d6c1f3 100644 --- a/README +++ b/README @@ -23,6 +23,36 @@ for testing purposes). Start with source that is cloned directly from Savannah. See [[https://savannah.gnu.org/git/?group=emacs][the Savannah page]] and look for "ELPA". Using a clone of a clone does not work. +You must then do some setup: +#+begin_src shell + make setup +#+end_src + +That leaves the =packages= directory empty; you must check out the +ones you want. + +If you wish to check out all the packages into the =packages= +directory, you can run the command: + +#+begin_src shell + make worktrees +#+end_src + +You can check out a specific package == into the =packages= +directory with this command: + +#+begin_src + make packages/ +#+end_src + +If you already have a =packages/= directory with a previous +checkout, you can update it like this: + +#+begin_src + cd packages/PACKAGE + git pull +#+end_src + * Directory layout ** =admin/= -- scripts for administering the package archive. @@ -221,28 +251,6 @@ and push that change to the master branch of =elpa=. After it's added to the =elpa-packages= file, the package can be maintained just by pushing changes to the =externals/= branch. -If you wish to check out all the packages into the =packages= -directory, you can run the command: - -#+begin_src shell - make worktrees -#+end_src - -You can check out a specific package == into the =packages= -directory with these commands: - -#+begin_src - make packages/ -#+end_src - -If you already have a =packages/= directory with a previous -checkout, you can update it like this: - -#+begin_src - cd packages/PACKAGE - git pull -#+end_src - ** Public incubation If you want to develop a package publicly prior to its first release (to --=-=-=--