[somethingwithproof]

Description

Rewrites README.md so that each statement matches the code on origin/develop. INFO and manifest.json are unchanged; no code is touched.

Related Issue

None.

Motivation and Context

The old README had an install paragraph and little else, and parts of it were wrong or missing:

• the package file names used a different case than the files in templates/ ("Stats" against "stats");
• it did not say the poller is off by default (hmib_enabled), that PHP 8.0 or later is needed, or that the Graphs tab fails on Cacti 1.2.32;
• it did not describe the two realms, the settings, the command line scripts, the CSV format for OS types, upgrade, uninstall, translations or the test commands.

New facts the README now states that a reader could not guess: the automation setting is used as a number of days (poller_graphs.php:101 multiplies by 86400, so "1 Hour" is one day); upgrade deletes tests/ and phpunit.xml from the plugin directory; uninstall keeps the saved settings, the core indexes the plugin added and the imported packages; Rescan can change the type of a device that already has one through the regular expression branch.

How Has This Been Tested?

Every claim was checked against origin/develop, either by reading the line or by running the command, in a throwaway Cacti (develop and 1.2.32; 1.2.25 for the install and page checks) with PHP 8.4 in Docker and MariaDB 11.8. Plugin lifecycle used php cli/plugin_manage.php. Cacti's cacti.log was restored afterwards.

Claim	Evidence	Result
compat 1.2.25	INFO:29; install on 1.2.25	confirmed
PHP 8.0 or later	php -l on 7.4, 8.0, 8.1	fails on 7.4, passes on 8.0 and 8.1
CI runs PHP 8.2, 8.3, 8.4 on MariaDB 11.8, CACTI 1.2.x	plugin-ci-workflow.yml:38,52,57	confirmed
Install, enable, disable, uninstall via CLI	plugin_manage.php --install --enable, --disable, --uninstall	works; tables dropped on uninstall
28 OS types, 51 type names seeded	row counts after install	confirmed
10 MyISAM tables, plugin_hmib_processes is MEMORY	information_schema engines	confirmed
Realms Viewer/Admin granted to admin	setup.php:65-66; user_auth_realm rows	confirmed
Uninstall keeps core indexes	index list after uninstall	4 indexes remain
Settings names, defaults, values	setup.php config arrays	confirmed
Poller off by default	poller_hmib.php:121, poller_graphs.php:94	exits when hmib_enabled is empty
Automation interval in days	poller_graphs.php:101; ran with frequency 1 and last run 2 h, 27 h, 90 days ago; frequency 12, 100 h ago	2 h and 100 h: "Not Time to Run"; 27 h and 90 days: starts
Script options	--version and --help of the three scripts	confirmed; -fd has no effect
Summary page note	requested the page before and after importing the Summary package and then Cacti's Net-SNMP package	note stays until the Net-SNMP templates exist
Pages respond	request of each action on 1.2.25, 1.2.32, develop	200 everywhere; Graphs tab fatal on 1.2.32 only
CSV export header and import rules	ran export, re-import, skip, update	confirmed
Rescan: 'New Type' per distinct pair, regex path changes typed devices	ran Rescan on fixtures	confirmed
Upgrade steps	setup.php:161 (hmib_check_upgrade), :762 (hmib_prune_files)	read, not executed
Translations: 23 languages	locales/po listing; locales/build_gettext.sh in Debian bookworm with GNU gettext	script runs; it needs include/cacti_version, which is absent outside a Cacti tree
Test commands	pest, pest with coverage, validate-manifest.php, check-i18n-pot.php origin/develop~1, patch-coverage.php	34 passed, 1 skipped; the three tools exit 0

Not run: PHP 8.2 to 8.4 CI matrix itself, a remote data collector, SNMPv3 devices.

Screenshots (if appropriate):

None.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation repository accordingly.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud