diff options
author | Philippe Charnier <charnier@FreeBSD.org> | 2003-02-05 14:00:46 +0000 |
---|---|---|
committer | Philippe Charnier <charnier@FreeBSD.org> | 2003-02-05 14:00:46 +0000 |
commit | 60dca836a79d55a9d39ee0b91bed775747d9c028 (patch) | |
tree | 784e284b89c2f076ac3977f73f911e02af6a6f39 /share | |
parent | c74076852fea2053ebf6e2f8dfe5338e2807b4cf (diff) |
The .Fn function
Notes
Notes:
svn path=/head/; revision=110397
Diffstat (limited to 'share')
-rw-r--r-- | share/man/man9/malloc.9 | 11 | ||||
-rw-r--r-- | share/man/man9/namei.9 | 12 |
2 files changed, 14 insertions, 9 deletions
diff --git a/share/man/man9/malloc.9 b/share/man/man9/malloc.9 index 5626529319dd..ad5ccc4ec384 100644 --- a/share/man/man9/malloc.9 +++ b/share/man/man9/malloc.9 @@ -65,8 +65,9 @@ function allocates uninitialized memory in kernel address space for an object whose size is specified by .Fa size . .Pp +The .Fn free -releases memory at address +function releases memory at address .Fa addr that was previously allocated by .Fn malloc @@ -156,11 +157,12 @@ rather than block. Note that .Dv M_NOWAIT is required when running in an interrupt context. +The .Fn malloc , .Fn realloc , and .Fn reallocf -can only return +functions can only return .Dv NULL if .Dv M_NOWAIT @@ -205,12 +207,13 @@ MALLOC(buf, struct foo_buf *, sizeof *buf, M_FOOBUF, M_NOWAIT); .Ed .Sh RETURN VALUES +The .Fn malloc , .Fn realloc , and .Fn reallocf -return a kernel virtual address that is suitably aligned for storage of -any type of object, or +functions return a kernel virtual address that is suitably aligned for +storage of any type of object, or .Dv NULL if the request could not be satisfied (implying that .Dv M_NOWAIT diff --git a/share/man/man9/namei.9 b/share/man/man9/namei.9 index 6046458d75fb..7cb5d067ba35 100644 --- a/share/man/man9/namei.9 +++ b/share/man/man9/namei.9 @@ -50,8 +50,9 @@ .Ft void .Fn NDFREE "struct nameidata *ndp" "u_int operflags" .Sh DESCRIPTION +The .Fn namei -is used to get from a pathname to a vnode for the object. +function is used to get from a pathname to a vnode for the object. This is a necessity to start doing VFS operations. The vnode returned will have its reference count increased; when you're through with it, you have to release it using either @@ -66,7 +67,7 @@ It takes the following arguments: .Pp .Bl -tag -width nameidatap .It Ar nameidatap -pointer to the struct nameidata to initialize +Pointer to the struct nameidata to initialize. .It Ar operation The operation to have .Fn namei @@ -89,15 +90,16 @@ Segment indicator. This tells if the name of the object is in userspace (UIO_USERSPACE) or in the kernel address space (UIO_SYSSPACE). .It Ar path Pointer to pathname buffer (the file or directory name that will be -looked up) +looked up). .It Ar td Which thread context to use for the .Fn namei locks. .El .Sh NAMEI OPERATION FLAGS +The .Fn namei -takes the following set of 'operation flags' that influence +function takes the following set of 'operation flags' that influence how it operates: .Bl -tag -width WANTPARENT .It Dv LOCKLEAF @@ -144,7 +146,7 @@ for whatever the link points at, instead for the link itself). Do not call .Fn vfs_object_create for the returned vnode even if it is -just a VREG and we're able to (ie, it is locked). +just a VREG and we're able to (i.e., it is locked). .It Dv NOFOLLOW Do not follow symbolic links (pseudo). This flag is not looked for by the actual code, which looks for |