X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=Kernel%2Finclude%2Fvfs.h;h=f6659430c6070596e4ceafbb6886b8f085e823bb;hb=8be652c8915e16cd64b0b34c84ca43d9f892ded9;hp=e3a61d4359394773a110b150f0fa15d0d4503008;hpb=775bf8013abe9fe4ef3d4883ea2e43bba2a84da1;p=tpg%2Facess2.git

diff --git a/Kernel/include/vfs.h b/Kernel/include/vfs.h
index e3a61d43..f6659430 100644
--- a/Kernel/include/vfs.h
+++ b/Kernel/include/vfs.h
@@ -67,7 +67,7 @@
  */
 
 /**
- * \brief VFS Node
+ * \brief Represents a node (file or directory) in the VFS tree
  * 
  * This structure provides the VFS with the functions required to read/write
  * the file (or directory) that it represents.
@@ -99,8 +99,9 @@ typedef struct sVFS_Node
 	Uint32	Flags;	//!< File Flags
 	
 	/**
-	 * Pointer to cached data (FS Specific)
-	 * \note Inode_* will free when the node is uncached this if needed
+	 * \brief Pointer to cached data (FS Specific)
+	 * \note The Inode_* functions will free when the node is uncached
+	 *       this if needed
 	 */
 	void	*Data;
 	/**
@@ -160,7 +161,7 @@ typedef struct sVFS_Node
 	 int	(*IOCtl)(struct sVFS_Node *Node, int Id, void *Data);
 	
 	/**
-	 * }
+	 * \}
 	 */
 	
 	/**
@@ -190,7 +191,7 @@ typedef struct sVFS_Node
 	Uint64	(*Write)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
 	
 	/**
-	 * }
+	 * \}
 	 */
 	
 	/**
@@ -224,7 +225,7 @@ typedef struct sVFS_Node
 	 * \param Node	Pointer to this node
 	 * \param Name	Name of the new child
 	 * \param Flags	Flags to apply to the new child (directory or symlink)
-	 * \return Boolean success
+	 * \return Zero on Success, non-zero on error (see errno.h)
 	 */
 	 int	(*MkNod)(struct sVFS_Node *Node, char *Name, Uint Flags);
 	
@@ -236,9 +237,18 @@ typedef struct sVFS_Node
 	 * \return Zero on Success, non-zero on error (see errno.h)
 	 */
 	 int	(*Relink)(struct sVFS_Node *Node, char *OldName, char *NewName);
+	
+	/**
+	 * \brief Link a node to a name
+	 * \param Node	Pointer to this node (directory)
+	 * \param Child	Node to create a new link to
+	 * \param NewName	Name for the new link
+	 * \return Zeron on success, non-zero on error (see errno.h)
+	 */
+	 int	(*Link)(struct sVFS_Node *Node, struct sVFS_Node *Child, char *NewName);
 	 
 	 /**
-	  * }
+	  * \}
 	  */
 } tVFS_Node;
 
@@ -316,11 +326,11 @@ extern tVFS_ACL	*VFS_UnixToAcessACL(Uint Mode, Uint Owner, Uint Group);
  * \{
  */
 /**
- * \fn int Inode_GetHandle()
+ * \fn int Inode_GetHandle(void)
  * \brief Gets a unique handle to the Node Cache
  * \return A unique handle for use for the rest of the Inode_* functions
  */
-extern int	Inode_GetHandle();
+extern int	Inode_GetHandle(void);
 /**
  * \fn tVFS_Node *Inode_GetCache(int Handle, Uint64 Inode)
  * \brief Gets an inode from the node cache