"Basil L. Contovounesios" <[email protected]> writes:

> Simon Josefsson via Gnulib discussion list [2025-11-26 22:31 +0100] wrote:
>
>> I pushed your two final patches:
>
> Thank you.  I signed my side of the CA papers last week, but have yet to
> receive them back.  Are my papers on file now?

It usually takes more time... I think you'll hear back when this is
completed.

>> 0001-announce-gen-Accommodate-alternative-NEWS-formats.patch
>
> Is it expected that this one doesn't update ChangeLog?

Sorry about messing up the ChangeLog entry, I had some conflict when
applying the patches and messed up.  Thanks Bruno for fixing this.

>> I will now try to convert GNU InetUtils to use NEWS.md, to see how this
>> works.
>
> Thanks,

Some observations:

0) Markdown of NEWS make things pretty on markdown-supporting mirrors:

https://gitlab.com/gsasl/inetutils/-/blob/master/NEWS.md?ref_type=heads
https://codeberg.org/inetutils/inetutils/src/branch/main/NEWS.md
https://github.com/jas4711/inetutils/blob/main/NEWS.md

Yay!

I'm not sure what markup we should recommend between the '#
Noteworthy...'  section headings, I think there is some room for
improvements here?  Suggestions?

1) Older automake really wants a NEWS file:

Makefile.am: error: required file './NEWS' not found

I solve this by adding a symlink in git, NEWS -> NEWS.md which is
similar to my README -> README.md symlink that I've been using in
several packages for a couple of years.

2) I realized that 'make dist' will not add the symlink NEWS and README
into the tarball but will instead add the target of those symlinks into
the tarball.  This means the tarball does not have a NEWS.md or
README.md (unless those are added to EXTRA_DIST, but then we get two
copies of the same file in the tarball).  Which further means we now
have markdown markup used in a non-*.md file.  I haven't had any problem
with README vs README.md due to this, but it seems sub-optimal.

What is a good improvement here?  I suppose symlinks in tarballs aren't
portable?  I think my preference is to only have a NEWS.md and README.md
file in the 'make dist' tarball.  But there is an awful amount of legacy
the refers to NEWS and README files.  Could we re-interpret them as not
refering to those files explicitly, but the concept of those files?
Which is provided via NEWS.md and README.md.

Thoughts?

/Simon

Attachment: signature.asc
Description: PGP signature

Reply via email to