* bug#62856: 30.0.50; nongnu.git documentation out of date
@ 2023-04-15 7:29 No Wayman
2023-04-15 13:09 ` Philip Kaludercic
0 siblings, 1 reply; 6+ messages in thread
From: No Wayman @ 2023-04-15 7:29 UTC (permalink / raw)
To: 62856
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.
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#62856: 30.0.50; nongnu.git documentation out of date
2023-04-15 7:29 bug#62856: 30.0.50; nongnu.git documentation out of date No Wayman
@ 2023-04-15 13:09 ` Philip Kaludercic
2023-09-05 20:50 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Philip Kaludercic @ 2023-04-15 13:09 UTC (permalink / raw)
To: No Wayman; +Cc: 62856
No Wayman <iarchivedmywholelife@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
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#62856: 30.0.50; nongnu.git documentation out of date
2023-04-15 13:09 ` Philip Kaludercic
@ 2023-09-05 20:50 ` Stefan Kangas
2023-09-05 21:29 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 6+ messages in thread
From: Stefan Kangas @ 2023-09-05 20:50 UTC (permalink / raw)
To: Philip Kaludercic; +Cc: No Wayman, 62856, Stefan Monnier
Philip Kaludercic <philipk@posteo.net> writes:
> No Wayman <iarchivedmywholelife@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?
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#62856: 30.0.50; nongnu.git documentation out of date
2023-09-05 20:50 ` Stefan Kangas
@ 2023-09-05 21:29 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-05 21:36 ` Stefan Kangas
0 siblings, 1 reply; 6+ messages in thread
From: Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-09-05 21:29 UTC (permalink / raw)
To: Stefan Kangas; +Cc: Philip Kaludercic, No Wayman, 62856
>>> 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
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#62856: 30.0.50; nongnu.git documentation out of date
2023-09-05 21:29 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
@ 2023-09-05 21:36 ` Stefan Kangas
2023-09-05 22:08 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 6+ messages in thread
From: Stefan Kangas @ 2023-09-05 21:36 UTC (permalink / raw)
To: Stefan Monnier; +Cc: Philip Kaludercic, No Wayman, 62856
Stefan Monnier <monnier@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?
^ permalink raw reply [flat|nested] 6+ messages in thread
* bug#62856: 30.0.50; nongnu.git documentation out of date
2023-09-05 21:36 ` Stefan Kangas
@ 2023-09-05 22:08 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 0 replies; 6+ messages in thread
From: Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2023-09-05 22:08 UTC (permalink / raw)
To: Stefan Kangas; +Cc: Philip Kaludercic, No Wayman, 62856
Stefan Kangas [2023-09-05 14:36:20] wrote:
> Stefan Monnier <monnier@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
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2023-09-05 22:08 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-04-15 7:29 bug#62856: 30.0.50; nongnu.git documentation out of date No Wayman
2023-04-15 13:09 ` Philip Kaludercic
2023-09-05 20:50 ` Stefan Kangas
2023-09-05 21:29 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-05 21:36 ` Stefan Kangas
2023-09-05 22:08 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).