From 7bd5d9f97d7a153b9e8f386f6f04310e5ccceeb4 Mon Sep 17 00:00:00 2001 From: Jarry Shaw Date: Tue, 22 Sep 2026 00:52:37 -0400 Subject: [PATCH] fix(license): start the copyright term at 2017, and drop the end year Requested by the owner; no issue is open for it. * `LICENSE:3` began the term at 2018, a year after the work it covers. The repository's first commit is `c57f7d0b7` "Initial commit", dated 2017-11-07, so the notice understated the term and disagreed with `docs/source/conf.py`, which already computes its Sphinx footer from 2017. * That start year was wrong from the moment it was first written. `bc836cfa2` (2020-05-31) introduced `2018-2020` when the BSD-3-Clause text replaced MPL 2.0 -- the file until then was stock MPL carrying no author notice at all -- and the range was then bumped by hand three times, to `2018-2022`, `2018-2023` and `2018-2026` (#615), each bump correcting the end year and copying `2018` forward untouched. * The end year is dropped rather than automated. The notice ships inside the sdist and the wheel, so it cannot be computed at read time the way the docs footer is; copyright subsists from creation regardless of the notice; and BSD-3-Clause's canonical form carries a single year. No workflow, hook or script is added in its place -- that was considered and rejected. * `docs/source/conf.py` is untouched: already self-maintaining, already starting at 2017, and a docs footer showing a range is conventional. * Changelog bullet added; `CHANGELOG.md` regenerated with `util/changelog_md.py`, and `--check` exits 0. The licence body is unaltered -- the whole-file diff is one hunk at line 3, and the remaining 28 lines carry the canonical BSD-3-Clause wording verbatim. Three things distinguish the file from SPDX's bare `licenseText`, all of them pre-existing: the `BSD 3-Clause License` title line, the `*` bullets in place of `1.`/`2.`/`3.`, and the extra `All rights reserved.` line. No tests were run: one line of legal prose, nothing under `pcapkit/`. --- CHANGELOG.md | 2 ++ LICENSE | 2 +- docs/source/changelog/1.5.0.rst | 32 ++++++++++++++++++++++++++++++++ 3 files changed, 35 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 49167a1eb..6e595d284 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -78,6 +78,8 @@ This is the resolution of #548, which reported `TransType.L2TP` (115) as registe - **Fixed** -- `main` went red the moment #604's `ljust()` landed, because `TCPUDPUnitTests.test_a_truncated_option_still_parses_its_declared_length` still pinned the head-padded short read that fix removed. The `Reserved_79` option declaring `length=12` over 6 real octets now reports `aabbccddeeff00000000` where the test expected `00000000aabbccddeeff`, so both subtests -- `declared_length=12` and `=32` -- failed on that one assertion while the 17 other cases in the file stayed green: the parse itself never changed, only which end the synthesised zeros sit at. The expectation is inverted, and the docstring above it -- which said the short read was *left*-padded and described the value as four zero octets followed by the six real ones -- is corrected to match, since a docstring that contradicts its own assertion is how the stale expectation survived in the first place. The inputs do discriminate: `trailing` is non-zero and the pad width is 4 and 24, so neither subtest would hold under the other order. #621 left this file alone deliberately, because #612 owned it at the time, and merged two minutes ahead of the cross-review verdict that named it (#604, #621). - **Fixed** -- `util/bump_version.py` left `CITATION.cff` naming the previous release. Nothing else in the repository maintains that file -- no workflow, hook or packaging file mentions it -- so every bump since it landed in #615 would have stranded the `version` and `date-released` it renders as GitHub's "Cite this repository" button and that citation managers, Zenodo and dependency inventories read directly. Both fields now move with `__version__`. They have the same standing, since the file's own header says both describe the newest *published* release, and moving only one would assert that 1.5.0b5 was released on the day 1.5.0b4 was; the date is taken in UTC, because seven of the thirty most recent bumps were made late evening in US-Eastern where a local date is a day behind the publish it describes. That the two are the same day at all is measured rather than assumed: the bump is what triggers `create-release.yml`, the median gap to the PyPI upload is three minutes, and the UTC calendar dates agree 30 times out of 30. The rewrite is line-oriented, so the comment header, key ordering and each field's existing quoting survive -- `cff-version` and a `references` entry's own `version` are anchored out at column zero -- and the result is checked with `cffconvert --validate`. An absent file is reported on stderr and skipped rather than failing the vendor cron before its `git commit`, which would discard the whole registry crawl for the sake of a documentation file; a file present with no `version` field raises instead, before anything is written, because rewriting nothing while reporting success is the staleness this fixes. Two things came with it. The script gains a `main()` guard, having previously run the entire bump at import, which is why it had no testable surface; and the `import pcapkit` fallback in its version reader, which returned `"1.5.0b4'\n"` -- closing quote and newline included, which `packaging` rejects -- is fixed, a path that had never worked and went unnoticed because the only caller installs the package first. A new gate asserts the committed file still names the packaged version, covering the version changes made by hand, which never run this script at all -- 40 of the 159 commits that have moved `__version__` on `main`, a quarter over the project's life and 11 of the most recent 25 (#625). +- **Fixed** -- `LICENSE`'s copyright notice began the term at 2018, a year after the work it covers. The repository's first commit is `c57f7d0b7` "Initial commit", dated 2017-11-07, so the notice understated the term and contradicted the only other copyright site in the tree: `docs/source/conf.py` computes its Sphinx footer as `f'2017-{datetime.date.today().year}, Jarry Shaw'` and has said 2017 for as long as it has existed. The two now agree on where the term starts. The wrong start year survived every maintenance pass the line has had, because each looked only at the other end of the range: `bc836cfa2` (2020-05-31) introduced `2018-2020` when the BSD-3-Clause text replaced MPL 2.0 -- the file until then was stock MPL text carrying no author notice at all, so 2018 is the first start year the project ever asserted and it was already a year late when it was written -- and the range was then bumped by hand three times, to `2018-2022`, `2018-2023` and `2018-2026` (#615), each bump correcting the end year and copying `2018` forward untouched. The end year is **dropped** rather than automated, which is the other half of the change: the notice ships inside the sdist and the wheel, so its text is fixed at build time in every copy already downloaded and cannot be computed the way the docs footer is; copyright subsists from creation whether or not a notice names the current year; and BSD-3-Clause's canonical form is `Copyright (c) `, singular. So a range here is six years of hand maintenance on one line buying nothing, and no workflow, script hook or other automation is added in its place -- that was considered and rejected, since automating a value that need not be current is worse than not carrying it. `conf.py` is deliberately untouched, a self-maintaining docs footer showing a range being both conventional and correct. The licence body is unaltered: the whole-file diff is one hunk at line 3, and the remaining 28 lines carry the canonical BSD-3-Clause wording verbatim. Three things distinguish the file from SPDX's bare `licenseText`, and all three predate this change -- the `BSD 3-Clause License` title line, which the opensource.org template carries and SPDX omits; the `*` bullets in place of `1.`/`2.`/`3.`; and the extra `All rights reserved.` line -- and the `DAMAGE.` that #615 repaired from a stray `DAMAGE.s` is still clean (#630). + Preceded by `1.5.0a1` (2026-09-15), `1.5.0b1` and `1.5.0b2` (both 2026-09-18) and `1.5.0b3` (2026-09-19), all published as prereleases and so resolved only by `pip install --pre`. `1.5.0b1` half-shipped: the tag, the GitHub release and the Conda deployments landed, but PyPI rejected the wheel because `twine check` found a Sphinx-only `:mod:` role in `README.rst`, which `pyproject.toml` declares as the dynamic long description. `1.5.0b2` is what reshipped it -- the release workflow is version-driven, so an existing version cannot republish -- and `1.5.0b3` followed the CI change that stops a TestPyPI outage from costing a release its wheels (#497, #498). --- diff --git a/LICENSE b/LICENSE index 5d8442d77..571e90f4b 100755 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2018-2026, Jarry Shaw +Copyright (c) 2017, Jarry Shaw All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/docs/source/changelog/1.5.0.rst b/docs/source/changelog/1.5.0.rst index 96e7dcd6e..8b2afd6a3 100644 --- a/docs/source/changelog/1.5.0.rst +++ b/docs/source/changelog/1.5.0.rst @@ -1064,6 +1064,38 @@ pull requests between #326 and #509. all -- 40 of the 159 commits that have moved ``__version__`` on ``main``, a quarter over the project's life and 11 of the most recent 25 (#625). +* **Fixed** -- ``LICENSE``'s copyright notice began the term at 2018, a year after + the work it covers. The repository's first commit is ``c57f7d0b7`` "Initial + commit", dated 2017-11-07, so the notice understated the term and contradicted the + only other copyright site in the tree: ``docs/source/conf.py`` computes its Sphinx + footer as ``f'2017-{datetime.date.today().year}, Jarry Shaw'`` and has said 2017 + for as long as it has existed. The two now agree on where the term starts. The + wrong start year survived every maintenance pass the line has had, because each + looked only at the other end of the range: ``bc836cfa2`` (2020-05-31) introduced + ``2018-2020`` when the BSD-3-Clause text replaced MPL 2.0 -- the file until then was + stock MPL text carrying no author notice at all, so 2018 is the first start year the + project ever asserted and it was already a year late when it was written -- and the + range was then bumped by hand three times, to ``2018-2022``, ``2018-2023`` and + ``2018-2026`` (#615), each bump correcting the end year and copying ``2018`` + forward untouched. The end year is + **dropped** rather than automated, which is the other half of the change: the + notice ships inside the sdist and the wheel, so its text is fixed at build time in + every copy already downloaded and cannot be computed the way the docs footer is; + copyright subsists from creation whether or not a notice names the current year; + and BSD-3-Clause's canonical form is ``Copyright (c) ``, singular. So + a range here is six years of hand maintenance on one line buying nothing, and no + workflow, script hook or other automation is added in its place -- that was + considered and rejected, since automating a value that need not be current is worse + than not carrying it. ``conf.py`` is deliberately untouched, a self-maintaining + docs footer showing a range being both conventional and correct. The licence body + is unaltered: the whole-file diff is one hunk at line 3, and the remaining 28 lines + carry the canonical BSD-3-Clause wording verbatim. Three things distinguish the + file from SPDX's bare ``licenseText``, and all three predate this change -- the + ``BSD 3-Clause License`` title line, which the opensource.org template carries and + SPDX omits; the ``*`` bullets in place of ``1.``/``2.``/``3.``; and the extra + ``All rights reserved.`` line -- and the ``DAMAGE.`` that #615 repaired from a + stray ``DAMAGE.s`` is still clean (#630). + Preceded by ``1.5.0a1`` (2026-09-15), ``1.5.0b1`` and ``1.5.0b2`` (both 2026-09-18) and ``1.5.0b3`` (2026-09-19), all published as prereleases and so resolved only by ``pip install --pre``. ``1.5.0b1`` half-shipped: the tag, the