Skip to content

fix: drop incorrect "sdkconfig is git-ignored" claim, document wireguard_lwip divergence - #2

Merged
fudio101 merged 1 commit into
mainfrom
fix/kconfig-credentials-comment
Aug 12, 2026
Merged

fix: drop incorrect "sdkconfig is git-ignored" claim, document wireguard_lwip divergence#2
fudio101 merged 1 commit into
mainfrom
fix/kconfig-credentials-comment

Conversation

@fudio101

Copy link
Copy Markdown
Collaborator

Two small, unrelated fixes found while auditing zen-clock (a consumer of this component).

components/microlink/Kconfig — credential comment overstated

The Credentials menu asserted as fact that sdkconfig "should be git-ignored" (1 comment line + 3 help texts). That's true for this repo's own examples, but not universally — zen-clock intentionally tracks sdkconfig in git and instead runs a guard script (check_secrets.py) before every commit that fails if a credential Kconfig is non-empty. The old wording put the wrong expectation in front of anyone configuring this component via menuconfig in a project that doesn't gitignore sdkconfig. Reworded to state where the value lives without prescribing how a consuming project must handle version control.

components/wireguard_lwip/README.md — no divergence warning, no upstream-check procedure

Only had the upstream URL. Added:

  • A warning that this copy has diverged substantially (own allowed_source_ips[] array vs upstream's single allowed_ip/allowed_mask, plus the ESP-IDF 6.x/GCC 15 patches and WG_DEBUG logging) — future syncs are manual merges, not fast-forwards.
  • The one-time git remote add smartalock ... + git log procedure for checking upstream, so it doesn't need to be rediscovered.
  • The result of the 2026-08-10 check: three commits past the divergence point (the cryptokey-routing source-IP security fix, a variable rename, two 2022 replay-detection fixes), all already present in this copy.

Verification

Built zen-clock (a real consumer) against this branch — clean build, no Kconfig errors:

RAM:   17.4% (57164 / 327680 bytes)
Flash: 44.9% (1883151 / 4194304 bytes)
========================= [SUCCESS] =========================

🤖 Generated with Claude Code

…ard_lwip divergence

The Credentials menu in components/microlink/Kconfig asserted as fact that
sdkconfig "should be git-ignored" — true for this repo's own examples, but
false for any consumer that intentionally tracks sdkconfig in git and protects
credentials some other way (a CI guard script, an ignored overlay file, etc).
A downstream consumer (zen-clock) tracks sdkconfig and had to build a
check_secrets.py guard specifically because this text put the wrong
expectation in front of users configuring the component via menuconfig.
Reworded to state where the value is stored without prescribing how a
consuming project must handle version control.

components/wireguard_lwip/README.md documented only the upstream URL, with no
warning that this copy has diverged (own allowed_source_ips[] array replacing
upstream's single allowed_ip/allowed_mask, plus the ESP-IDF 6.x/GCC 15 patches
and WG_DEBUG logging) and no procedure for checking upstream for new fixes.
Added both, plus the result of the 2026-08-10 upstream check: three commits
past the divergence point, all already present here.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@fudio101
fudio101 merged commit 8c3e762 into main Aug 12, 2026
fudio101 added a commit that referenced this pull request Aug 19, 2026
Issue #23 (captive-portal detection) was closed and merged via PR #48
on 2026-08-18 but the tracker table was never updated to reflect it —
the only row still missing a done marker. Also prunes the Notes
section's two "conflicts to resolve before scoping" callouts (#11,
#2-vs-#17), both already resolved in their own rows.

Co-authored-by: Adrian.Nguyen-Qualgo <nguyen.ndt@qualgo.net>
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant