Re: File Naming Conventions
| From: | Xavier Noguer | Date: | Mon, 06 Jan 2003 13:06:35 +0000 |
| Subject: | Re: File Naming Conventions | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-12158@lists.php.net to get a copy of this message | ||
El Dom 05 Ene 2003 06:53, Lorenzo Alberton escribió:
> I've noticed that there aren't any standards about example/test/doc
> file naming, so common names as "test.php", "example.php",
> "readme",
> etc. are often used. This is fine until there are other packages in the
> same category, that usually have a "readme" or "test.php" as well.
>
> Here I propose a naming standard for [ docs | tests | examples] files,
> which IMHO should be at least prefixed by package name,
> if nothing else.
>
> Just have a look:
>
> Net_Ident/examples/example.php
> Net_Url/docs/example.php
> Net_UserAgent/tests/example.php
>
> once installed, the directory structure would be:
>
> Net
>
> +-docs/example.php
>
> +-examples/example.php
>
> +-tests/example.php
Please correct me if I'm wrong, but I think the directory structure once
installed is given by the roles of the files.
Using your example, if you declare the role of Net_Url/docs/example.php as
"doc" (in package.xml) it will be installed as docs/Net_Url/example.php, not
Net/docs/example.php.
I'm not completly sure about this, so if someone who has actually worked with
the roles of files could confirm or correct this, it would be greatly
appreciated.