Skip to content

docs(deps): document snake_case PACKAGE_NAME convention and track upstream adoption#545

Merged
kcenon merged 1 commit into
mainfrom
docs/issue-543-document-snake-case-package-name-convention
Mar 16, 2026
Merged

docs(deps): document snake_case PACKAGE_NAME convention and track upstream adoption#545
kcenon merged 1 commit into
mainfrom
docs/issue-543-document-snake-case-package-name-convention

Conversation

@kcenon

@kcenon kcenon commented Mar 16, 2026

Copy link
Copy Markdown
Owner

What

Add a comprehensive PACKAGE_NAME Convention section to vcpkg-ports/README.md,
documenting the standardized snake_case naming for all 8 ecosystem ports and
tracking upstream adoption via filed issues.

Change Type

  • Documentation

Affected Components

  • vcpkg-ports/README.md — convention docs, find_package() reference, migration guide, upstream tracking table

Why

Problem Solved

Closes #543 — the convention established in #544 (portfile standardization) needed
to be documented so new ports and consumers follow it consistently. Upstream repos
that still use PascalCase CMake config paths needed issues filed to track when
wrapper code in portfiles can be removed.

Related Issues

Who

Reviewers

When

Urgency

  • Normal

Where

Files Changed

File Change
vcpkg-ports/README.md +80 / -5 lines

How

Changes Made

  1. PACKAGE_NAME Convention section — full documentation of the snake_case standard
  2. find_package() Reference table — all 8 ports with correct call syntax and primary targets
  3. Migration guide — before/after examples for consumers migrating from PascalCase
  4. Adding New Ports guide — step-by-step rules for new port authors
  5. Upstream Adoption Status table — tracks 4 upstream issues filed for native snake_case support:
  6. Canonical Status table sync — port-version numbers updated to match current portfiles
  7. Related Issues section — added chore(deps): Standardize CMake PACKAGE_NAME convention across ecosystem ports #532 and docs(deps): Document snake_case PACKAGE_NAME convention for ecosystem ports #543 for traceability

Testing Done

  • Documentation review — all links valid, table formatting verified

Breaking Changes

None — documentation only.

…tream adoption

Add PACKAGE_NAME Convention section to vcpkg-ports/README.md covering:
- find_package() reference table for all 8 ecosystem ports
- Migration guide from deprecated PascalCase package names
- Instructions for adding new ports with correct naming
- Upstream Adoption Status table linking to filed upstream issues

Filed upstream issues for native snake_case CMake config install paths:
- kcenon/logger_system#502
- kcenon/container_system#424
- kcenon/database_system#455
- kcenon/network_system#843

Also sync port-version numbers in Canonical Status table to match
current portfile states (logger:1, container:1, database:3, network:4, pacs:3).

Closes #543
Part of #532
@kcenon kcenon merged commit 67d6437 into main Mar 16, 2026
29 checks passed
@kcenon kcenon deleted the docs/issue-543-document-snake-case-package-name-convention branch March 16, 2026 02:50
kcenon added a commit that referenced this pull request Apr 13, 2026
…tream adoption (#545)

Add PACKAGE_NAME Convention section to vcpkg-ports/README.md covering:
- find_package() reference table for all 8 ecosystem ports
- Migration guide from deprecated PascalCase package names
- Instructions for adding new ports with correct naming
- Upstream Adoption Status table linking to filed upstream issues

Filed upstream issues for native snake_case CMake config install paths:
- kcenon/logger_system#502
- kcenon/container_system#424
- kcenon/database_system#455
- kcenon/network_system#843

Also sync port-version numbers in Canonical Status table to match
current portfile states (logger:1, container:1, database:3, network:4, pacs:3).

Closes #543
Part of #532
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.

docs(deps): Document snake_case PACKAGE_NAME convention for ecosystem ports

1 participant