From d89d6b1b65379272b98df40e6d8dc11e0564004b Mon Sep 17 00:00:00 2001 From: Michael Beck Date: Wed, 5 Aug 2026 01:55:13 -0400 Subject: [PATCH] chore(docs): reconcile the inventory with what git archive actually produces Module root has always held nine files; the summary said seven and the tree listing omitted LICENSE and composer.json entirely, so the total was short by two from the day those files were added. Counted against the real archive: 129, matching every other row. .gitattributes is rewritten with LF endings. Cosmetic -- git parses it either way, and export-ignore has been applying correctly all along. --- .gitattributes | 7 ++++--- docs/file-list.md | 6 ++++-- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.gitattributes b/.gitattributes index 1c8b6a5..1e79ae3 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,11 +1,10 @@ # Path-based git attributes — XOOPS module DevOps baseline. # xoops-overlay:profile=core27 # https://git-scm.com/docs/gitattributes - +# Stored with LF line endings, like everything else here. # Normalize line endings. * text=auto *.php text eol=lf - # Keep development & CI files OUT of the release archive (git archive / GitHub release ZIP). /.github export-ignore /.build export-ignore @@ -13,8 +12,9 @@ /tests export-ignore /testdata export-ignore # /docs export-ignore +/docs/00 export-ignore +/docs/00/** export-ignore /.editorconfig export-ignore -/.gitattributes export-ignore /.gitignore export-ignore /.php-cs-fixer.dist.php export-ignore /.php-cs-fixer.cache export-ignore @@ -31,6 +31,7 @@ /sonar-project.properties export-ignore /.git-blame-ignore-revs export-ignore /composer.lock export-ignore +/.gitattributes export-ignore # CHANGELOG.md deliberately SHIPS, diverging from the module-devops baseline. # It is the industry-standard location, and the About tab will read the release # history from it once docs/changelog.txt is retired. diff --git a/docs/file-list.md b/docs/file-list.md index 8324cd5..678844f 100644 --- a/docs/file-list.md +++ b/docs/file-list.md @@ -6,7 +6,7 @@ This inventory describes the standalone `modules/debugbar` release tree. The thr | Area | Files | Purpose | |---|---:|---| -| Module root | 7 | Manifest, entry points, README, and changelog | +| Module root | 9 | Manifest, entry points, README, changelog, licence, and the Composer manifest | | Administration | 8 | Home, Analytics, Logs, Diagnostics, navigation, and wrappers | | PHP classes | 27 | Collection, profiling, storage, diagnostics, event/template collectors, and optional Ray bridge | | Install and preload | 4 | Autoloading, lifecycle registration, schema/assets/key setup | @@ -15,7 +15,7 @@ This inventory describes the standalone `modules/debugbar` release tree. The thr | SQL | 1 | Profile table definition | | Module asset overlay | 6 | XOOPS-specific styles and scripts reapplied during update | | Generated browser assets | 32 | Web-readable PHP DebugBar resources plus copied overlay files | -| **Total** | **127** | Excludes the three review notes, and the development and CI files that `.gitattributes` marks `export-ignore` — `tests/`, `stubs/`, `testdata/`, `.github/`, and the tooling configs — none of which reach the release archive | +| **Total** | **129** | Excludes the three review notes, and the development and CI files that `.gitattributes` marks `export-ignore` — `tests/`, `stubs/`, `testdata/`, `.github/`, and the tooling configs — none of which reach the release archive | ## Module-owned source tree @@ -23,6 +23,8 @@ This inventory describes the standalone `modules/debugbar` release tree. The thr debugbar/ |-- README.md |-- CHANGELOG.md +|-- LICENSE +|-- composer.json |-- xoops_version.php |-- index.php |-- explain.php