docs: document not to use FILENAME_MAX in our codebase

It's a weird thing. Let's explain why.
This commit is contained in:
Lennart Poettering 2021-03-08 22:43:07 +01:00
parent f470d234d3
commit b775b1828d

View file

@ -587,6 +587,12 @@ layout: default
time you need that please immediately undefine `basename()`, and add a
comment about it, so that no code ever ends up using the POSIX version!
- Never use FILENAME_MAX. Use PATH_MAX instead (for checking maximum size of
paths) and NAME_MAX (for checking maximum size of filenames). FILENAME_MAX is
not POSIX, and is a confusingly named alias for PATH_MAX on Linux. Note the
NAME_MAX does not include space for a trailing NUL, but PATH_MAX does. UNIX
FTW!
## Committing to git
- Commit message subject lines should be prefixed with an appropriate component