php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #36977 Doc's for symlink are confusing
Submitted: 2006-04-04 21:49 UTC Modified: 2006-05-16 03:33 UTC
From: mpb dot mail at gmail dot com Assigned: ramsey (profile)
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS:
Private report: No CVE-ID: None
View Developer Edit
Welcome! If you don't have a Git account, you can't do anything here.
If you reported this bug, you can edit this bug over here.
(description)
Block user comment
Status: Assign to:
Package:
Bug Type:
Summary:
From: mpb dot mail at gmail dot com
New email:
PHP Version: OS:

 

 [2006-04-04 21:49 UTC] mpb dot mail at gmail dot com
Description:
------------
On this page: http://us2.php.net/manual/en/function.symlink.php

I get confused every time a read the following sentence:

"symlink() creates a symbolic link from the existing target with the specified name link."

In my opinion, "from" is the wrong direction.  Would it not be clearer to say:

"symlink() creates a symbolic link named link that points to target.  Typically, target is a file or directory that already exists."


Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2006-04-05 16:14 UTC] vrana@php.net
Current wording follows parameters order.
 [2006-04-05 16:40 UTC] mpb dot mail at gmail dot com
vrana@php.net Closed this bug saying:

"Current wording follows parameters order."

Respectfully:

1) At the very least, the word "from" should be changed to the word "to".

2) If the parameter names were listed in column 1 of a table, with descriptions in column 2, then I agree that they should be listed in order.

3) However, as the description of the parameters is a single English sentence, I believe that sentence should be written for clarity.

4) The symlink man pages on both Linux and FreeBSD list the parameters in reverse order, and are both much clearer than the PHP docs.  I prefer the Linux version.

Linux:

int symlink(const char *oldpath, const char *newpath);

symlink() creates a symbolic link named newpath which contains the string oldpath.

FreeBSD:

int symlink(const char *name1, const char *name2);

A symbolic link name2 is created to name1 (name2 is the name of the file created, name1 is the string used in creating the symbolic link).

I will not reopen this bug again.  Thank you!
 [2006-05-16 03:33 UTC] ramsey@php.net
My symlink man page says:

int symlink(const char *name1, const char *name2);
A symbolic link name2 is created to name1

The order of the parameters doesn't necessarily have to dictate the order in which they appear in a sentence describing them, as we can see from above. However, rewording the sentence as it is in the PHP manual is unnecessary. Simply changing the word "from" to "to" will add sufficient clarity, so that is what I have done.
 
PHP Copyright © 2001-2025 The PHP Group
All rights reserved.
Last updated: Tue Jul 08 16:01:33 2025 UTC