Re: New ELPA package: transient-cycles

[Sean Whitton <spwhitton@spwhitton.name>]

[-- Attachment #1: Type: text/plain, Size: 948 bytes --]

Hello,

On Fri 08 Apr 2022 at 10:55pm -04, Stefan Monnier wrote:

>> The package does not have a git repository of its own.  For several
>> reasons I would prefer to keep it that way, and manually sync new
>> versions to elpa.git.  So I believe what I need to do to elpa.git is add
>> the line
>>
>>      ("transient-cycles"    :url nil)
>
> Yes, that basically means that `elpa.git` is the upstream repository.
> This is perfectly fine and that's what I do for "my" packages (like
> `nadvice.el`, `sml-mode.el`, ...).
>
>> to elpa-packages, and push a new branch externals/transient-cycles
>> containing the single file transient-cycles.el.  And then the scripts
>> should be able to extract the commentary and changelog.  Is that right?
>
> Yup.

Thanks.  I wanted to test the docs extraction and found after some
digging that 'make build/transient-cycles' was what I wanted.  What do
you think to the attached patch to README?

-- 
Sean Whitton

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-README-build-PKGNAME-can-be-used-to-test-docs-extrac.patch --]
[-- Type: text/x-diff, Size: 1022 bytes --]

From fa6d8df7173f11fe1a2bf9492866839b172e5f6b Mon Sep 17 00:00:00 2001
From: Sean Whitton <spwhitton@spwhitton.name>
Date: Sat, 9 Apr 2022 10:38:45 -0700
Subject: [PATCH] * README: build/[PKGNAME] can be used to test docs extraction

---
 README | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/README b/README
index cb437651fc..b60312d495 100644
--- a/README
+++ b/README
@@ -247,8 +247,11 @@ Else, it generates the auxiliary files like =[PKGNAME]-pkg.el= and
 Build that tarball from the commit currently in =packages/[PKGNAME]=
 
 ** =build/[PKGNAME]=
-Build the ELPA tarball(s) for PKGNAME.  The result is placed in
-the =archive= and =archive-devel= subdirectories.
+Build the ELPA tarball(s) and other files like PKGNAME.html and
+PKGNAME.svg for PKGNAME.  The result is placed in the =archive= and
+=archive-devel= subdirectories.
+
+This can be used to test commentary and changelog extraction.
 
 ** =build-all=
 Same as before but does it for all the packages listed in the
-- 
2.30.2