Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:71534
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: pass (pb1.pair.com: domain gmail.com designates 209.85.217.176 as permitted sender)
MIME-Version: 1.0
Sender: yohgaki@gmail.com
In-Reply-To: <CAGa2bXbV-mWpDWWSFbsrMSBffp9=fdAbMrJ33f8KHuJiTAzi8w@mail.gmail.com>
References: <CAGa2bXbV-mWpDWWSFbsrMSBffp9=fdAbMrJ33f8KHuJiTAzi8w@mail.gmail.com>
Date: Sat, 25 Jan 2014 07:09:44 +0900
Message-ID: <CAGa2bXap2YyxdrgGk8ckUyEO=wVG3+qN+gKDz_ZcbMB2QqpWVA@mail.gmail.com>
To: "internals@lists.php.net" <internals@lists.php.net>
Content-Type: multipart/alternative; boundary=047d7b3432f4f1937604f0be9f32
Subject: Re: Module function API naming conventions
From: yohgaki@ohgaki.net (Yasuo Ohgaki)

--047d7b3432f4f1937604f0be9f32
Content-Type: text/plain; charset=UTF-8

Hi all,

On Fri, Jan 24, 2014 at 7:41 AM, Yasuo Ohgaki <yohgaki@ohgaki.net> wrote:

> When I try to add dummy save handler functions for session module,
> I noticed that ps_update() etc has been defined in SOAP module.
>
> To avoid collisions, we might better to have following change in
> CODING_STANDARDS.
>
> [yohgaki@dev PHP-5.4]$ git diff
> diff --git a/CODING_STANDARDS b/CODING_STANDARDS
> index 7a0562e..4c67a30 100644
> --- a/CODING_STANDARDS
> +++ b/CODING_STANDARDS
> @@ -82,7 +82,7 @@ Exceptions:
>      library may need to control or free the memory, or when the memory in
>      question needs to survive between multiple requests.
>
> -Naming Conventions
> +User Functions/Methods Naming Conventions
>  ------------------
>
>  1.  Function names for user-level functions should be enclosed with in
> @@ -163,6 +163,19 @@ Naming Conventions
>      'foobar'
>      'foo_bar'
>
> +Internal Function Naming Conventions
> +----------------------
> +
> +1.  Exposed module API must have 'php_modulename_function()' to avoid
> +    symbol collision. They should be in lowercase, with words
> +    underscore delimited.
> +
> +2.  Main module source file must be named modulename.c.
> +
> +3.  Header file that are used by other sources than it's module must be
> +    named 'php_modulename.h'.
> +
> +
>  Syntax and indentation
>  ----------------------
>
> The rule should be applied to new modules, not existing one.
> Main source and header is named like this, since ext_skel creates
> files as above.
>
> Any comments?
>

It seems no comments for this. This is mandatory. IMHO.
I'll commit this 5.4 and up today.
If there are corrections/additions, please update.

Regards,

--
Yasuo Ohgaki
yohgaki@ohgaki.net

--047d7b3432f4f1937604f0be9f32--