GNU bug report logs - #62856
30.0.50; nongnu.git documentation out of date

Previous Next

To reply to this bug, email your comments to 62856 AT debbugs.gnu.org.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: No Wayman <iarchivedmywholelife <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 30.0.50; nongnu.git documentation out of date
Date: Sat, 15 Apr 2023 03:29:12 -0400

nongnu.git's README and elpa-packages file claim each package will 
be on an "externals/NAME" branch. Instead the packages are on 
"elpa/NAME" branches. The elpa-config file implies this will be 
configurable at some point, but for now the docs are misleading.

Message #8 received at 62856 <at> debbugs.gnu.org (full text, mbox):

From: Philip Kaludercic <philipk <at> posteo.net>
To: No Wayman <iarchivedmywholelife <at> gmail.com>
Cc: 62856 <at> debbugs.gnu.org
Subject: Re: bug#62856: 30.0.50; nongnu.git documentation out of date
Date: Sat, 15 Apr 2023 13:09:24 +0000

No Wayman <iarchivedmywholelife <at> gmail.com> writes:

> nongnu.git's README and elpa-packages file claim each package will be
> on an "externals/NAME" branch. Instead the packages are on "elpa/NAME"
> branches. 

I am not exactly sure what is going on here, but the README file on the
elpa-admin branch mentions this:

--8<---------------cut here---------------start------------->8---
This file exists in two branches ~elpa-admin~ and ~elpa~.  The two version
differ slightly.  The introductory text before the first heading
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.
--8<---------------cut here---------------end--------------->8---


>           The elpa-config file implies this will be configurable at
> some point, but for now the docs are misleading.

It should be configurable?  Or at least `elpaa-read-config' does set it.

-- 
Philip Kaludercic

Message #11 received at 62856 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Philip Kaludercic <philipk <at> posteo.net>
Cc: No Wayman <iarchivedmywholelife <at> gmail.com>, 62856 <at> debbugs.gnu.org,
 Stefan Monnier <monnier <at> iro.umontreal.ca>
Subject: Re: bug#62856: 30.0.50; nongnu.git documentation out of date
Date: Tue, 5 Sep 2023 13:50:59 -0700

Philip Kaludercic <philipk <at> posteo.net> writes:

> No Wayman <iarchivedmywholelife <at> gmail.com> writes:
>
>> nongnu.git's README and elpa-packages file claim each package will be
>> on an "externals/NAME" branch. Instead the packages are on "elpa/NAME"
>> branches.
>
> I am not exactly sure what is going on here, but the README file on the
> elpa-admin branch mentions this:
>
> This file exists in two branches ~elpa-admin~ and ~elpa~.  The two version
> differ slightly.  The introductory text before the first heading
> 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.
>
>
>>           The elpa-config file implies this will be configurable at
>> some point, but for now the docs are misleading.
>
> It should be configurable?  Or at least `elpaa-read-config' does set it.

Stefan, do you have any comments here?

Message #14 received at 62856 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: Philip Kaludercic <philipk <at> posteo.net>,
 No Wayman <iarchivedmywholelife <at> gmail.com>, 62856 <at> debbugs.gnu.org
Subject: Re: bug#62856: 30.0.50; nongnu.git documentation out of date
Date: Tue, 05 Sep 2023 17:29:40 -0400

>>> nongnu.git's README and elpa-packages file claim each package will be
>>> on an "externals/NAME" branch. Instead the packages are on "elpa/NAME"
>>> branches.
>>
>> I am not exactly sure what is going on here, but the README file on the
>> elpa-admin branch mentions this:
>>
>> This file exists in two branches ~elpa-admin~ and ~elpa~.  The two version
>> differ slightly.  The introductory text before the first heading
>> 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.
>>
>>
>>>           The elpa-config file implies this will be configurable at
>>> some point, but for now the docs are misleading.
>>
>> It should be configurable?  Or at least `elpaa-read-config' does set it.
>
> Stefan, do you have any comments here?

Not much to add: the README in `elpa-admin` is supposed to be "generic"
(under the assumption that `elpa-admin` could be used for many other
archives), whereas the READMEs in the `main` branch of `elpa.git` and
`nongnu.git` should describe what's specific to the corresponding
(Non)GNU ELPA case and delegate the rest to the `elpa-admin` README.


        Stefan

Message #17 received at 62856 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Philip Kaludercic <philipk <at> posteo.net>,
 No Wayman <iarchivedmywholelife <at> gmail.com>, 62856 <at> debbugs.gnu.org
Subject: Re: bug#62856: 30.0.50; nongnu.git documentation out of date
Date: Tue, 5 Sep 2023 14:36:20 -0700

Stefan Monnier <monnier <at> iro.umontreal.ca> writes:

> Not much to add: the README in `elpa-admin` is supposed to be "generic"
> (under the assumption that `elpa-admin` could be used for many other
> archives), whereas the READMEs in the `main` branch of `elpa.git` and
> `nongnu.git` should describe what's specific to the corresponding
> (Non)GNU ELPA case and delegate the rest to the `elpa-admin` README.

So notabug, then, or do you see anything that could be improved?

Message #20 received at 62856 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: Philip Kaludercic <philipk <at> posteo.net>,
 No Wayman <iarchivedmywholelife <at> gmail.com>, 62856 <at> debbugs.gnu.org
Subject: Re: bug#62856: 30.0.50; nongnu.git documentation out of date
Date: Tue, 05 Sep 2023 18:08:58 -0400

Stefan Kangas [2023-09-05 14:36:20] wrote:
> Stefan Monnier <monnier <at> iro.umontreal.ca> writes:
>> Not much to add: the README in `elpa-admin` is supposed to be "generic"
>> (under the assumption that `elpa-admin` could be used for many other
>> archives), whereas the READMEs in the `main` branch of `elpa.git` and
>> `nongnu.git` should describe what's specific to the corresponding
>> (Non)GNU ELPA case and delegate the rest to the `elpa-admin` README.
> So notabug, then,

On the contrary: the README for nongnu.git should be fixed so it doesn't
say "externals/.." since that doesn't apply to the `nongnu.git` case.

> or do you see anything that could be improved?

Actually, a lot could be improved.  What I describe above is what we aim
for, but the reality is pretty far from that: we managed to "merge" the
different redundant pieces of info (at some point, at least), which was
the first step, but we still need to split them according to
the guidelines which should then make it easier to keep those things
up-to-date.


        Stefan

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.