ON-15695: improve developer documentation

[matthewr-xilinx]

Make the TCPDirect github look more like the Onload repo.

[matthewr-xilinx]

Is it useful to add a LICENSE file too?

[pcolledg-amd]

Yes please to a ./LICENSE. Grepping the copyright lines, 2015 is the earliest header:

MIT License

Copyright (c) 2015-2024 Advanced Micro Devices, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

[matthewr-xilinx]

Yes please to a ./LICENSE. Grepping the copyright lines, 2015 is the earliest header:

It looks like there are a few files which are BSD-3-Clause instead of MIT. Can anyone remember why?

bash-4.2$ grep -R SPDX-License * | grep -v MIT
src/include/zf_internal/tcp.h:/* SPDX-License-Identifier: BSD-3-Clause */
src/include/zf_internal/tcp_types.h:/* SPDX-License-Identifier: BSD-3-Clause */
src/lib/zf/private/tcp_fast.c:/* SPDX-License-Identifier: BSD-3-Clause */
src/lib/zf/tcp_out.c:/* SPDX-License-Identifier: BSD-3-Clause */
src/lib/zf/tcp_core.c:/* SPDX-License-Identifier: BSD-3-Clause */
src/lib/zf/tcp_in.c:/* SPDX-License-Identifier: BSD-3-Clause */

[abower-amd]

The licence file is under doc/.

[matthewr-xilinx]

The licence file is under doc/.

Thanks. I'll see if I can add a symbolic link so we have a top-level LICENSE

[matthewr-xilinx]

Do we want to encourage people to run the ZF unit tests, as well as testing their specific feature?

[abower-amd]

The licence file is under doc/.

Thanks. I'll see if I can add a symbolic link so we have a top-level LICENSE

You're welcome to move it instead iff the Jenkins automation and packaging are still able to pick it up and put it in the right place.

Note this is basically a reformatted version of the Debian changelog, which is machine readable. I wouldn't be too upset about using that instead!