On Tue, 23 Jun 2009 14:34:50 -0700 (PDT) Davide Libenzi <davidel@xxxxxxxxxxxxxxx> wrote: > On Tue, 23 Jun 2009, Andrew Morton wrote: > > > > Should functions be describing all the returned error codes, ala man pages? > > > > > > > I think so. > > This becomes pretty painful when the function calls other functions, for > which just relays the error code. > Should we be just documenting the error codes introduced by the function > code, and say that the function returns errors A, B, C plus all the ones > returned by the called functions X, Y, Z? > If not, it becomes hell in maintaining the comments... Well. Don't worry about making rules. Taste and common sense apply. "Will it be useful to readers if I explicitly document the return value". If "yes" then document away. If "no" then don't. -- To unsubscribe from this list: send the line "unsubscribe kvm" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
