netdev - Re: [EXT] Re: [PATCH net-next 1/2] qed*: enhance tx timeout debug info

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20211126164102.358d0a0e@kicinski-fedora-pc1c0hjn.dhcp.thefacebook.com>
Date:   Fri, 26 Nov 2021 16:41:02 -0800
From:   Jakub Kicinski <kuba@...nel.org>
To:     Manish Chopra <manishc@...vell.com>
Cc:     "netdev@...r.kernel.org" <netdev@...r.kernel.org>,
        Ariel Elior <aelior@...vell.com>,
        Alok Prasad <palok@...vell.com>,
        Prabhakar Kushwaha <pkushwaha@...vell.com>
Subject: Re: [EXT] Re: [PATCH net-next 1/2] qed*: enhance tx timeout debug
 info

On Fri, 26 Nov 2021 22:04:03 +0000 Manish Chopra wrote:
> > Please consider using devlink health if you want to communicate more data to
> > the user  
> 
> It's not really that huge logs/data, these are just very basic metadata (few prints) about the TX queues logged to system logs.
> Those can be looked easily from dmesg/var-log-messages files which can be made available conveniently.
> Rest are the mailbox commands posted to management firmware with those basic information about the queues.

Right, I meant "more" as in if it keeps growing in the future, not
necessarily to replace this patch.

> > > +/**
> > > + * qed_int_get_sb_dbg: Read debug information regarding a given SB
> > > + *
> > > + * @p_hwfn: hw function pointer
> > > + * @p_ptt: ptt resource
> > > + * @p_sb: pointer to status block for which we want to get info
> > > + * @p_info: pointer to struct to fill with information regarding SB
> > > + *
> > > + * Return: Int  
> > 
> > What's the point of documenting the return type?  
> 
> For ./scripts/kernel-doc, I will put some suitable description. 

I don't think it requires documenting return value. All arguments -
yes, but not documenting return value is fine. So you can as well
remove it, up to you.