From owner-freebsd-fs Fri Aug 27 13:35: 0 1999 Delivered-To: freebsd-fs@freebsd.org Received: from critter.freebsd.dk (critter.freebsd.dk [212.242.40.131]) by hub.freebsd.org (Postfix) with ESMTP id 7DAB816064; Fri, 27 Aug 1999 13:34:48 -0700 (PDT) (envelope-from phk@critter.freebsd.dk) Received: from critter.freebsd.dk (localhost [127.0.0.1]) by critter.freebsd.dk (8.9.3/8.9.2) with ESMTP id WAA06795; Fri, 27 Aug 1999 22:32:27 +0200 (CEST) (envelope-from phk@critter.freebsd.dk) To: Erez Zadok Cc: Matthew Dillon , Alfred Perlstein , hackers@FreeBSD.ORG, fs@FreeBSD.ORG, Michael Hancock , David Greenman Subject: Re: HEADS UP Reviewers. VFS changes to be committed. In-reply-to: Your message of "Fri, 27 Aug 1999 16:18:45 EDT." <199908272018.QAA22373@shekel.mcl.cs.columbia.edu> Date: Fri, 27 Aug 1999 22:32:27 +0200 Message-ID: <6793.935785947@critter.freebsd.dk> From: Poul-Henning Kamp Sender: owner-freebsd-fs@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.org Uhm, have any of you actually ever looked at src/sys/kern/vnode_if.src ? Poul-Henning In message <199908272018.QAA22373@shekel.mcl.cs.columbia.edu>, Erez Zadok write s: >In message <199908261727.KAA23308@apollo.backplane.com>, Matthew Dillon writes: >[...] >> I would ask two things though: >> >> * First, please add comprehensive /* */ comments in front of each >> vfsnop_*() procedure explaining what it does, why it returns what >> it returns, locking requirements (if any) on entry, and side effects >> on return. This is just for readability. >> >> Do the same for all the procedures you are adding, in fact. > >Moreover, I would strongly recommend xplicitly documenting the following: > >- which function args are in-args and which are out-args? > >- does the function takes any allocated memory that it is expected to free? > >- is the function expected to allocate any memory objects that have to be > freed elsewhere? > >- does the function increase or decrease any reference counts of any objects? > Is it expected to? > >These and other requirements are essentially the "interface" between the VFS >and lower-level file systems. Figuring out this stuff on every OS and OS >revision (esp. when the VFS changes so often---linux) was the longest most >frustrating task I faced when writing my Wrapfs stackable f/s module for >solaris, freebsd, and linux. I wish documentation had been in place. > >> * I think you can safely commit any elements that are not used by >> existing builds since they are not likely to impact existing >> builds operationally. >> >> Then see what you have left over. If it is not significant, commit >> that to. If it is significant, do more comprehensive testing on >> what you have left over (i.e. that impacts existing builds) and >> ask for another review after testing, before committing it. > >Erez. > > >To Unsubscribe: send mail to majordomo@FreeBSD.org >with "unsubscribe freebsd-fs" in the body of the message > -- Poul-Henning Kamp FreeBSD coreteam member phk@FreeBSD.ORG "Real hackers run -current on their laptop." FreeBSD -- It will take a long time before progress goes too far! To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-fs" in the body of the message