Commit Graph

51 Commits

Author SHA1 Message Date
christos 1371fc4088 sync with reality 2019-05-05 20:10:57 +00:00
wiz 01869ca4d2 Remove workaround for ancient HTML generation code. 2017-07-03 21:28:48 +00:00
abhinav d0483ad66f Fix a sentence: s/a operation/an operation/ 2017-05-03 17:28:42 +00:00
abhinav e6867880ee Fixes in NAME section:
Insert comma between two Nm entries
	Remove comma after last Nm entries
2017-05-03 16:37:37 +00:00
wiz 465830a019 Add width argument to list. 2017-03-21 10:12:28 +00:00
riastradh e166f0a8ba Bump date. 2017-03-18 21:18:09 +00:00
riastradh 36d5892792 Remove excessive indentation from function description text. 2017-03-18 19:05:38 +00:00
riastradh c0cb46f60e Move out-of-place note about interrupt context and namei.
Tweak paragraph break.
2017-03-18 19:03:23 +00:00
riastradh 88f8641118 Use `\(em', not `--'.
Refill sentences and tweak wording where appropriate while here.
2017-03-18 19:01:01 +00:00
riastradh ffba06d595 Clarify wording: pathname component is not a vnode or lookup result. 2017-03-18 18:55:49 +00:00
riastradh dd3919cd22 Organize namei flags by whose perspective they are relevant to.
- namei callers
- input to VOP_LOOKUP set by caller
- input to VOP_LOOKUP set by namei
- output from VOP_LOOKUP
2017-03-18 18:53:43 +00:00
riastradh c7e3d53cec Rewrite intro to say positively, actively how you use namei. 2017-03-18 18:13:15 +00:00
riastradh 74f8d4473e Rewrite operating modes section.
- Identify contract with caller.
- Identify contract with file system.
- Identify failure modes.
- Write in bulleted lists, not long rambly paragraphs.
2017-03-18 17:55:23 +00:00
riastradh 5f0f612ab5 Clarify what NOCACHE and MAKEENTRY do and who uses them.
De-editorialize.
2017-03-18 16:12:20 +00:00
wiz 2bfa6b5acf Use Er for errors and Dq for double quoted strings. Whitespace nits. 2016-05-07 08:52:10 +00:00
dholland 30c3425723 Revise/update. List the functions in a sensible order. Document all
the modes and flags. Document the structure fields properly.
Distinguish internals from public interfaces. Mention historic dead
flags like SAVESTART because they still exist in other projects.
Explain the current layout of vfs_lookup.c, or at least the primary
points of it.

Etc.

This ended up being a much larger rewrite than I intended.

Bump date again.
2016-05-06 04:55:10 +00:00
salazar d076c54ad0 update struct nameidata documentation 2016-05-05 17:06:41 +00:00
wiz 79a213efae Bump date for previous. 2015-04-21 10:00:30 +00:00
riastradh f07d4c6e8b Cull long-dead flags from namei(9) man page. 2015-04-21 03:21:54 +00:00
dholland 4a960bb603 Update a comment on a structure description. Noted by wiz a long time
ago.

does not seem to be worth bumping the date for.
2014-06-21 04:28:23 +00:00
njoly 4bfb4fdd36 Fix section (3 -> 2) in openat xref. 2013-04-09 13:29:07 +00:00
wiz 9948aa60be Bump date for previous. 2012-11-05 22:44:22 +00:00
dholland f90296b2d3 Document NDAT(), and while here update some of the now-outdated
material in the namei man page. There's quite a bit more to be done.
2012-11-05 17:31:53 +00:00
dholland a2c3393810 These two man pages contain complete cut and paste copies of struct
componentname and/or struct nameidata. Update the copies, for both
today's changes and a number of earlier changes too.
2012-11-05 17:30:37 +00:00
wiz 05859157e6 Remove boilerplate in CODE REFERENCES on file paths.
Describe in intro(9) how to read paths in the CODE REFERENCES section.
2010-12-02 12:54:13 +00:00
dholland 4756f11bab bump date for previous (thanks jnemeth) 2010-11-19 07:44:00 +00:00
dholland 8f6ed30d57 Introduce struct pathbuf. This is an abstraction to hold a pathname
and the metadata required to interpret it. Callers of namei must now
create a pathbuf and pass it to NDINIT (instead of a string and a
uio_seg), then destroy the pathbuf after the namei session is
complete.

Update all namei call sites accordingly. Add a pathbuf(9) man page and
update namei(9).

The pathbuf interface also now appears in a couple of related
additional places that were passing string/uio_seg pairs that were
later fed into NDINIT. Update other call sites accordingly.
2010-11-19 06:44:33 +00:00
wiz 91b16df666 Bump date for today's changes. 2009-09-27 21:05:55 +00:00
dholland 8d36057243 Move a big wodge of symlink-following code from nfsd to inside
lookup_for_nfsd(). This code is, or at least should be, the same as
the regular symlink-following code plus an extra flag nfsd needs.

The two lots of code can/will be merged in the future.
2009-09-27 17:23:53 +00:00
dholland fb458255a3 Rename lookup() to lookup_for_nfsd(), to make it clear just whose
private backdoor entry point this is.

Also, clone the lookup_for_nfsd() entry point as
lookup_for_nfsd_index(), for use by a different call site in nfsd that
does different unclean things with nameidata.
2009-09-27 17:19:07 +00:00
wiz 8f62518cea Use more markup. Punctuation nit. 2009-06-29 06:02:09 +00:00
dholland 0633e5d59f Bump date for previous (thanks uebayasi@) 2009-06-29 05:49:28 +00:00
dholland 847d7ba4a1 Document namei_simple_kernel and namei_simple_user. 2009-06-29 05:17:14 +00:00
martin 11a6dbe728 Convert TNF licenses to new 2 clause variant 2008-04-30 13:10:46 +00:00
pooka 844fb47f15 The leprechaun is dead, update interfaces. 2007-12-28 18:05:22 +00:00
pooka b013a2d4f9 Include struct componentname declaration in struct namei - it's
usually the more interesting of the two anyway.
2007-06-30 18:55:19 +00:00
pooka 21a7d11f2b Fix description on what is returned locked and when.
noticed by Rumble
2007-06-28 08:02:41 +00:00
wiz 103c72a1ca Bump date for previous. 2006-12-23 09:36:56 +00:00
chs c398ae9734 a smorgasbord of improvements to vnode locking and path lookup:
- LOCKPARENT is no longer relevant for lookup(), relookup() or VOP_LOOKUP().
   these now always return the parent vnode locked.  namei() works as before.
   lookup() and various other paths no longer acquire vnode locks in the
   wrong order via vrele().  fixes PR 32535.
   as a nice side effect, path lookup is also up to 25% faster.
 - the above allows us to get rid of PDIRUNLOCK.
 - also get rid of WANTPARENT (just use LOCKPARENT and unlock it).
 - remove an assumption in layer_node_find() that all file systems implement
   a recursive VOP_LOCK() (unionfs doesn't).
 - require that all file systems supply vfs_vptofh and vfs_fhtovp routines.
   fill in eopnotsupp() for file systems that don't support being exported
   and remove the checks for NULL.  (layerfs calls these without checking.)
 - in union_lookup1(), don't change refcounts in the ISDOTDOT case, just
   adjust which vnode is locked.  fixes PR 33374.
 - apply fixes for ufs_rename() from ufs_vnops.c rev. 1.61 to ext2fs_rename().
2006-12-09 16:11:50 +00:00
rumble f76a328cb8 Update namei(9) comments and man page to indicate that we operate on
vnodes, not inodes.
2006-03-03 16:15:11 +00:00
rpaulo ff8e3c8c68 More ktrace-lwp that I got wrong in the first try.
Thanks to Gregory McGarry for pointing this out.
2006-01-29 03:09:19 +00:00
rpaulo 7d7fe4b786 Adapt man pages to ktrace-lwp. 2005-12-20 19:53:14 +00:00
jmmv 4296d7d483 Drop trailing whitespace. Reviewed by wiz. 2003-05-06 10:46:41 +00:00
wiz 472351e13d Use
.In header.h
instead of
.Fd #include \*[Lt]header.h\*[Gt]
Much easier to read and write, and supported by groff for ages.
Okayed by ross.
2003-04-16 13:34:34 +00:00
dbj 952f555608 grammar nit. "set to." changed to "to which" 2003-04-13 07:15:20 +00:00
wiz ec59b4a790 Fix two typos, from Igor Sobrado in PR 19680. 2003-04-06 15:52:38 +00:00
perry 43e0efbdeb "Utilize" has exactly the same meaning as "use," but it is more
difficult to read and understand. Most manuals of English style
therefore say that you should use "use".
2003-02-04 22:38:15 +00:00
wiz 770eef2122 New sentence, new line. 2002-10-14 13:43:14 +00:00
ross 4fa402f116 Generate <>& symbolically. I'm avoiding .../dist/... directories for now. 2002-02-13 08:17:26 +00:00
wiz 1978ea7c16 Whitespace, punctuation fixes; sort sections, fix xrefs. 2001-10-22 08:21:32 +00:00