Some more documentation.

This commit is contained in:
Serge van den Boom
2013-09-29 19:02:56 +02:00
parent d848ccf96f
commit 29beca352b
+49 -11
View File
@@ -123,18 +123,56 @@ no problem, as long as the repositories don't overlap.
-= Internals =-
Types:
uio_MountTree - A node in a data structure describing the mounted directories.
uio_PRoot - A struct describing the a physical file system.
uio_PRootExtra - Filesystem-dependant extra data for a PRoot.
uio_GPRoot - Generic filesystem-dependant data for a PRoot, used as
uio_PRootExtra.
uio_GPRootExtra - Extra filesystem-dependant data for a PRoot, when using
uio_GPRoot for generic filesystem-dependant data.
uio_GPDir - Generic structure representing a node in a physical directory
structure describing one directory.
uio_GPFile - Generic structure describing a file in a physical file system.
uio_MountTree
A node in a data structure describing the mounted directories.
uio_PRoot
A struct describing the a physical file system.
uio_PRootExtra
Filesystem-dependant extra data for a PRoot.
uio_GPRoot
Generic filesystem-dependant data for a PRoot, used as uio_PRootExtra.
uio_GPRootExtra
Extra filesystem-dependant data for a PRoot, when using uio_GPRoot for
generic filesystem-dependant data.
uio_GPDir
Generic structure representing a node in a physical directory structure
describing one directory.
uio_GPFile
Generic structure describing a file in a physical file system.
TODO: functions
Helper functions (defined in ioaux.c):
uio_copyFilePhysical
Copy a file from one physical directory to another.
uio_getPathPhysicalDirs
Get handles to the (existing) physical dirs that are effective in a
path 'path' relative from 'dirHandle'
uio_getPhysicalAccess
Find PDirHandle and MountInfo structures for reading and writing for a path
from a DirHandle.
uio_makePath
Create a directory inside a physical directory. All non-existant
parent directories will be created as well.
uio_resolvePath
Determine the absolute path given a path relative to a given directory.
uio_verifyPath
Test whether a path is valid and exists.
uio_walkPhysicalPath
Follow a path starting from a specified physical dir for as long as
possible.