From: Stephen Hemminger <shemminger@vyatta.com>
To: "Subbu Seetharaman" <subbus@serverengines.com>
Cc: netdev@vger.kernel.org
Subject: Re: [PATCH 3/12] BE NIC driver - net_object i/f functions, Makefile
Date: Tue, 3 Jun 2008 10:02:15 -0700 [thread overview]
Message-ID: <20080603100215.5789bf06@extreme> (raw)
In-Reply-To: <20080603094046.28f72fb5@mailhost.serverengines.com>
> +/*
> +
> +@file
> + bni.c
> +
> +@brief
> + This file contains finctions that will be used by the BladeEngine
> + Network drivers to access BladeEngine Hardware. All code in
> + this file must be completely OS neutral.
> +
> +*/
> +
> +#include "bni.h"
> +
> +/*!
> + This function initializes the data structures in BNI / BECLIB for network
> + operation. The OSM driver must call this function before making any other
> + BNI call.
> +
> + If this functions succeeds, the caller must call bni_cleanup() as part
> + of driver cleanup procedure.
> +
> +@param
> + chipobj - Address of the space allocated by OSM for chip object
> + (struct be_chip_object). The space for this is
> + allocated by OSM, but this object is maintained
> + by BECLIB and is opaque to OSM.
> +@return
> + BESTATUS - (0 if successful, non-zero status code if not successful)
> +
> + */
You commenting standard is similar but not compatiable with kernel docboock.
But I don't consider this a blocker to inclusion, just a nuisance.
> +BESTATUS bni_init(struct be_chip_object *chipobj)
> +{
> + int r;
> + r = be_initialize_library();
> + if (r != BE_SUCCESS)
> + goto error;
> + r = be_chip_object_create(chipobj);
> + if (r != BE_SUCCESS)
> + goto error;
> +error:
> + return (r);
> +}
But this overly verbose code style is the style of code which should be cleaned
up (after inclusion). It is the reason that kernel developers hate drivers that
try to be OS independent. They end up looking like the kind of rubbish written
by contracting software houses that are paid by the line of code.
next prev parent reply other threads:[~2008-06-03 17:02 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-06-03 9:40 [PATCH 3/12] BE NIC driver - net_object i/f functions, Makefile Subbu Seetharaman
2008-06-03 17:02 ` Stephen Hemminger [this message]
-- strict thread matches above, loose matches on Subject: below --
2008-06-05 16:36 Subbu Seetharaman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20080603100215.5789bf06@extreme \
--to=shemminger@vyatta.com \
--cc=netdev@vger.kernel.org \
--cc=subbus@serverengines.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).