Skip to content

fix: add necessary comment to the preload file - #9822

Closed
michalsn wants to merge 1 commit into
codeigniter4:developfrom
michalsn:fix/preload
Closed

fix: add necessary comment to the preload file#9822
michalsn wants to merge 1 commit into
codeigniter4:developfrom
michalsn:fix/preload

Conversation

@michalsn

Copy link
Copy Markdown
Member

Description
This PR updates the sample preload.php file to include a short note in the instructions indicating that the debug echo statement should be removed before using the file in a real preloading setup. Preloading scripts are expected not to produce output, so this clarification helps prevent accidental usage of the sample with debug output left enabled.

Fixes#9821

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value (without duplication)
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

@michalsnmichalsn added bug Verified issues on the current code behavior or pull requests that will fix them documentation Pull requests for documentation only labels Dec 5, 2025
@paulbalandan

Copy link
Copy Markdown
Member

I'm thinking if we should do the opposite instead: comment the echo line and add a note to uncomment that for debugging?

@neznaika0

Copy link
Copy Markdown
Contributor

In my opinion, it's better to leave it - it's immediately clear that you need to update the paths and remove the output.
Although it looks like a bug after testing.

@michalsnmichalsn mentioned this pull request Dec 5, 2025
5 tasks
@michalsn

Copy link
Copy Markdown
MemberAuthor

I'm fine with changing it. Please see an alternative PR: #9825

@michalsn
michalsn deleted the fix/preload branch December 10, 2025 13:39
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugVerified issues on the current code behavior or pull requests that will fix themdocumentationPull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug: preload.php has an echo statement in it that messes up spark command output

3 participants

@michalsn@paulbalandan@neznaika0