Skip to content

docs: add note about special characters in paths#6192

Merged
kenjis merged 2 commits intocodeigniter4:developfrom
kenjis:fix-docs-special-characters-in-paths
Jun 28, 2022
Merged

docs: add note about special characters in paths#6192
kenjis merged 2 commits intocodeigniter4:developfrom
kenjis:fix-docs-special-characters-in-paths

Conversation

@kenjis
Copy link
Copy Markdown
Member

@kenjis kenjis commented Jun 28, 2022

Description
Fixes #6190

  • add note about special characters in paths

Checklist:

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

@kenjis kenjis added the documentation Pull requests for documentation only label Jun 28, 2022
If you omit the "project-root" argument, the command will create an
"appstarter" folder, which can be renamed as appropriate.

.. note:: CodeIgniter autoloader does not allow special characters that are illegal in filenames on certain operating systems. Only allow characters deemed safe for POSIX portable filenames, plus the forward slash for directory separators. So if you install CodeIgniter under the folder that contains the special characters like ``(``, ``)``, etc., CodeIgniter won't work.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we just list down what are those allowed instead of not allowed? I believe the allowed list is smaller than the not allowed.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added allowed symbols.

Download the `latest version <https://github.com/CodeIgniter4/framework/releases/latest>`_,
and extract it to become your project root.

.. note:: CodeIgniter autoloader does not allow special characters that are illegal in filenames on certain operating systems. Only allow characters deemed safe for POSIX portable filenames, plus the forward slash for directory separators. So if you install CodeIgniter under the folder that contains the special characters like ``(``, ``)``, etc., CodeIgniter won't work.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment above.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug: spark not working if directory path contains parentheses

2 participants