BUG: v2.6.0 missing seccomp_export_bpf_mem(3) manpage, release notes, and CHANGELOG mentions

[kolyshkin]

It was added by commit 3f0e47f absent from but release notes never mention it.

I've also checked that v2.5.6 doesn't have it.

[kolyshkin]

but release notes never mention it.

They actually do, but indirectly only ("Add a seccomp_precompute() API to generate the seccomp BPF filter prior to seccomp_load() or seccomp_export_bpf_mem()").

I guess it's OK to edit release notes on github post release. I guess the CHANGELOG can also be updated.

[pcmoore]

Yes, there is no reason we can't update both the CHANGELOG or GH release notes after the fact.

[pcmoore]

I sat down to fix this and realized the problem is a bit larger than just a missing reference, we're missing mention of it in the manpage too. Adjusting the subject to reflect this.

I think we can "add" this to the release-2.6 stream since the functionality does exist in v2.6.0, we just don't document it or provide much in the way of notice.

Thanks for catching this @kolyshkin !

[kolyshkin]

I sat down to fix this and realized the problem is a bit larger than just a missing reference, we're missing mention of it in the manpage too.

As far as I can see, the man page is there:

[kir@kir-tp1 libseccomp]$ git checkout v2.6.0 
Note: switching to 'v2.5.6'.
<...>
[kir@kir-tp1 libseccomp]$ cat doc/man/man3/seccomp_export_bpf_mem.3 
.so man3/seccomp_export_bpf.3

And the seccomp_export_bpf(3) correctly describes seccomp_export_bpf_mem(3).

The only issue is, if you do something like

[kir@kir-tp1 libseccomp]$ man ./doc/man/man3/seccomp_export_bpf_mem.3

then man will show you the system's man page, not the local one. I actually bumped into this myself a few times yesterday.

OTOH if you use man ./doc/man/man3/seccomp_export_bpf.3 you will see the local man page.

[kolyshkin]

I sat down to fix this and realized the problem is a bit larger than just a missing reference, we're missing mention of it in the manpage too.

As far as I can see, the man page is there:
<...>

I also checked the release tarball at https://github.com/seccomp/libseccomp/releases/tag/v2.6.0 and it does contain these changes, too, so I guess we're fine wrt man page.

[pcmoore]

It looks like all we needed to do was update the CHANGELOG, so I've added a new item in main via 9d7a3cd and in release-2.6 via 4c21f22.

I also updated the GH release notes for v2.6.0, but for obvious reasons I didn't regenerate the tarball or the release tag; those will need to wait for v2.6.1.

Thanks everyone!