Commit 08767a26 authored by Jakub Kicinski's avatar Jakub Kicinski Committed by Paolo Abeni
Browse files

docs: netdev: broaden the new vs old code formatting guidelines 



Convert the "should I use new or old comment formatting" to cover
all formatting. This makes the question itself shorter.

Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
Reviewed-by: default avatarFlorian Fainelli <f.fainelli@gmail.com>
Signed-off-by: default avatarPaolo Abeni <pabeni@redhat.com>
parent 99eba4e5

Documentation/networking/netdev-FAQ.rst

+4 −4
Original line number Diff line number Diff line
@@ -183,10 +183,10 @@ it is requested that you make it look like this:: 
   * another line of text

   */



I am working in existing code that has the former comment style and not the latter. Should I submit new code in the former style or the latter?

-----------------------------------------------------------------------------------------------------------------------------------------------

Make it the latter style, so that eventually all code in the domain

of netdev is of this format.

I am working in existing code which uses non-standard formatting. Which formatting should I use?

------------------------------------------------------------------------------------------------

Make your code follow the most recent guidelines, so that eventually all code

in the domain of netdev is in the preferred format.



I found a bug that might have possible security implications or similar. Should I mail the main netdev maintainer off-list?

---------------------------------------------------------------------------------------------------------------------------