examples/legacy_smoke/ states a committed-capture count in four places. All four are correct on main
today and all four become false when #697 lands, because #697 stops tracking the four rendered
reports (out.json, out.plist, out.txt, pcapng.txt), taking the tracked set from six to two.
| site |
text |
examples/legacy_smoke/README.rst:118 |
"Four files in ../captures/ are committed outputs rather than inputs" |
examples/legacy_smoke/README.rst:139 |
"rewrites every timestamp line in all four files" |
examples/legacy_smoke/README.rst:141 |
"the PCAP three having been generated at UTC-05:00" |
examples/legacy_smoke/Makefile:14 |
"## Regenerate the four committed fixtures in ../captures/." |
Makefile:21's @echo also names all four, and the whole "Regenerating the committed fixtures" section
(README.rst:115-144) plus the fixtures target will describe regenerating files that are no longer
tracked.
A pre-existing contradiction in the same file, independent of #697
README.rst:23-24 and :118 already disagree on main:
:23-24 The captures live in ``../captures/``. Only ``in.pcap`` and ``dhcp.pcapng`` are
committed; the rest are generated, so build them once before running anything else:
:118 Four files in ``../captures/`` are committed outputs rather than inputs, and they are
Six files are tracked today (dhcp.pcapng, in.pcap, out.json, out.plist, out.txt,
pcapng.txt) = 2 inputs + 4 committed outputs, so :118 is right and :23-24 is wrong as of now.
#697 flips the polarity of both rather than removing the inconsistency.
Suggested fix
Drop the counts rather than updating them — an updated number rots on the next capture, and count-free
prose is correct both before and after #697. This is the same approach taken for the test-tree comments
in #700 / PR #703, which replaced "there are six today" with "or stops committing one".
These files are owned by #697, so the change belongs on that branch rather than as a separate PR;
otherwise #697 merges with four false statements in files it is itself editing. Found while reviewing
#703, verified independently twice.
examples/legacy_smoke/states a committed-capture count in four places. All four are correct onmaintoday and all four become false when #697 lands, because #697 stops tracking the four rendered
reports (
out.json,out.plist,out.txt,pcapng.txt), taking the tracked set from six to two.examples/legacy_smoke/README.rst:118../captures/are committed outputs rather than inputs"examples/legacy_smoke/README.rst:139examples/legacy_smoke/README.rst:141examples/legacy_smoke/Makefile:14../captures/."Makefile:21's@echoalso names all four, and the whole "Regenerating the committed fixtures" section(
README.rst:115-144) plus thefixturestarget will describe regenerating files that are no longertracked.
A pre-existing contradiction in the same file, independent of #697
README.rst:23-24and:118already disagree onmain:Six files are tracked today (
dhcp.pcapng,in.pcap,out.json,out.plist,out.txt,pcapng.txt) = 2 inputs + 4 committed outputs, so:118is right and:23-24is wrong as of now.#697 flips the polarity of both rather than removing the inconsistency.
Suggested fix
Drop the counts rather than updating them — an updated number rots on the next capture, and count-free
prose is correct both before and after #697. This is the same approach taken for the test-tree comments
in #700 / PR #703, which replaced "there are six today" with "or stops committing one".
These files are owned by #697, so the change belongs on that branch rather than as a separate PR;
otherwise #697 merges with four false statements in files it is itself editing. Found while reviewing
#703, verified independently twice.