From b775b1828df8d3ee53e8706cc8ca3d0b8726a621 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Mon, 8 Mar 2021 22:43:07 +0100 Subject: [PATCH] docs: document not to use FILENAME_MAX in our codebase It's a weird thing. Let's explain why. --- docs/CODING_STYLE.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/CODING_STYLE.md b/docs/CODING_STYLE.md index 851676bc2bd..c15dc1abf7c 100644 --- a/docs/CODING_STYLE.md +++ b/docs/CODING_STYLE.md @@ -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