[PATCH] New include file for marking old style api files

[PATCH] New include file for marking old style api files

[Jiri Slaby]

[-- Attachment #1: Type: text/plain, Size: 308 bytes --]

Hi.
Do you think, that this would be useful in the kernel tree?
I have an idea to mark old drivers, which should I or somebody rewrite.
For example drivers/isdn/hisax/gazel.c.

-- 
Jiri Slaby         www.fi.muni.cz/~xslaby
~\-/~      jirislaby@gmail.com      ~\-/~
241B347EC88228DE51EE A49C4A73A25004CB2A10


[-- Attachment #2: lnx-oldapi-6.13r3m3.txt --]
[-- Type: text/plain, Size: 235 bytes --]

diff --git a/include/linux/oldapi.h b/include/linux/oldapi.h
new file mode 100644
--- /dev/null
+++ b/include/linux/oldapi.h
@@ -0,0 +1,2 @@
+#warning This driver uses old style API and needs to be rewritten or removed \
+	from kernel

Re: [PATCH] New include file for marking old style api files

[Jiri Slaby]

[-- Attachment #1: Type: text/plain, Size: 722 bytes --]

Jiri Slaby napsal(a):

> Hi.
> Do you think, that this would be useful in the kernel tree?
> I have an idea to mark old drivers, which should I or somebody rewrite.
> For example drivers/isdn/hisax/gazel.c.
>
>------------------------------------------------------------------------
>
>diff --git a/include/linux/oldapi.h b/include/linux/oldapi.h
>new file mode 100644
>--- /dev/null
>+++ b/include/linux/oldapi.h
>@@ -0,0 +1,2 @@
>+#warning This driver uses old style API and needs to be rewritten or removed \
>+	from kernel
>  
>
Maybe this would be better (license and comments added).

-- 
Jiri Slaby         www.fi.muni.cz/~xslaby
~\-/~      jirislaby@gmail.com      ~\-/~
241B347EC88228DE51EE A49C4A73A25004CB2A10


[-- Attachment #2: lnx-oldapi-6.13r3m3_1.txt --]
[-- Type: text/plain, Size: 570 bytes --]

diff --git a/include/linux/oldapi.h b/include/linux/oldapi.h
new file mode 100644
--- /dev/null
+++ b/include/linux/oldapi.h
@@ -0,0 +1,13 @@
+/**
+  * Include this file, if you think that the driver is old API styled
+  *
+  * Version:	1.0		28 Jul 2005	Initial version
+  *
+  * Author		Jiri Slaby <xslaby@fi.muni.cz>
+  *
+  * This software may be used and distributed according to the terms
+  * of the GNU General Public License, incorporated herein by reference.
+  */
+
+#warning This driver uses old style API and needs to be rewritten or removed \
+	from kernel

Re: [PATCH] New include file for marking old style api files

[John W. Linville]

On Thu, Jul 28, 2005 at 03:50:22PM +0200, Jiri Slaby wrote:
> Jiri Slaby napsal(a):
> 
> >Hi.
> >Do you think, that this would be useful in the kernel tree?
> >I have an idea to mark old drivers, which should I or somebody rewrite.
> >For example drivers/isdn/hisax/gazel.c.

Anyway you could modify this so that people could indicate which
"old" APIs are in use?

Just a thought...

John
-- 
John W. Linville
linville@tuxdriver.com

Re: [PATCH] New include file for marking old style api files

[Adrian Bunk]

On Thu, Jul 28, 2005 at 03:42:26PM +0200, Jiri Slaby wrote:
> Hi.
> Do you think, that this would be useful in the kernel tree?
> I have an idea to mark old drivers, which should I or somebody rewrite.
> For example drivers/isdn/hisax/gazel.c.
>...
> --- /dev/null
> +++ b/include/linux/oldapi.h
> @@ -0,0 +1,2 @@
> +#warning This driver uses old style API and needs to be rewritten or removed \
> +	from kernel

What's wrong with __deprecated ?

cu
Adrian

-- 

       "Is there not promise of rain?" Ling Tan asked suddenly out
        of the darkness. There had been need of rain for many days.
       "Only a promise," Lao Er said.
                                       Pearl S. Buck - Dragon Seed

Re: [PATCH] New include file for marking old style api files

[Jiri Slaby]

Adrian Bunk napsal(a):

>On Thu, Jul 28, 2005 at 03:42:26PM +0200, Jiri Slaby wrote:
>  
>
>>Hi.
>>Do you think, that this would be useful in the kernel tree?
>>I have an idea to mark old drivers, which should I or somebody rewrite.
>>For example drivers/isdn/hisax/gazel.c.
>>...
>>--- /dev/null
>>+++ b/include/linux/oldapi.h
>>@@ -0,0 +1,2 @@
>>+#warning This driver uses old style API and needs to be rewritten or removed \
>>+	from kernel
>>    
>>
>
>What's wrong with __deprecated ?
>  
>
Nothing, but this marks entire driver, not a function, that it uses.
I.e. gazel doesn't emit any warning or so, I think; so for these cases.

-- 
Jiri Slaby         www.fi.muni.cz/~xslaby
~\-/~      jirislaby@gmail.com      ~\-/~
241B347EC88228DE51EE A49C4A73A25004CB2A10

Re: [PATCH] New include file for marking old style api files

[Jan-Benedict Glaw]

[-- Attachment #1: Type: text/plain, Size: 1020 bytes --]

On Thu, 2005-07-28 16:07:57 +0200, Jiri Slaby <jirislaby@gmail.com> wrote:
> Adrian Bunk napsal(a):
> >What's wrong with __deprecated ?
> > 
> >
> Nothing, but this marks entire driver, not a function, that it uses.
> I.e. gazel doesn't emit any warning or so, I think; so for these cases.

So what's actually wrong with the gazel driver? I'm not an user or
author of it.

When it's the use of old APIs, I indeed think that __deprecated is
exactly what we want. If a driver is superseded by a different one (OSS
vs. ALSA, eepro100 vs e100, ...), sticking a #warning or #error right
into the driver (and not into an included header file) looks quite right
to me.

MfG, JBG

-- 
Jan-Benedict Glaw       jbglaw@lug-owl.de    . +49-172-7608481             _ O _
"Eine Freie Meinung in  einem Freien Kopf    | Gegen Zensur | Gegen Krieg  _ _ O
fuer einen Freien Staat voll Freier Buerger" | im Internet! |   im Irak!   O O O
ret = do_actions((curr | FREE_SPEECH) & ~(NEW_COPYRIGHT_LAW | DRM | TCPA));

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 189 bytes --]

Re: [PATCH] New include file for marking old style api files

[Adrian Bunk]

On Thu, Jul 28, 2005 at 04:07:57PM +0200, Jiri Slaby wrote:
> Adrian Bunk napsal(a):
> 
> >On Thu, Jul 28, 2005 at 03:42:26PM +0200, Jiri Slaby wrote:
> > 
> >
> >>Hi.
> >>Do you think, that this would be useful in the kernel tree?
> >>I have an idea to mark old drivers, which should I or somebody rewrite.
> >>For example drivers/isdn/hisax/gazel.c.
> >>...
> >>--- /dev/null
> >>+++ b/include/linux/oldapi.h
> >>@@ -0,0 +1,2 @@
> >>+#warning This driver uses old style API and needs to be rewritten or 
> >>removed \
> >>+	from kernel
> >>   
> >>
> >
> >What's wrong with __deprecated ?
> > 
> >
> Nothing, but this marks entire driver, not a function, that it uses.
> I.e. gazel doesn't emit any warning or so, I think; so for these cases.

Why do you require a header file for this?
Simply put the #warning in gazel.c .

If the API is scheduled for removal, you should put the #warning in the 
header file for the API.

If the API is old but is expected to stay for a longer time, simply do 
nothing. Artificially increasing the warnings during kernel compilation 
only makes it harder to find important warnings.

cu
Adrian

-- 

       "Is there not promise of rain?" Ling Tan asked suddenly out
        of the darkness. There had been need of rain for many days.
       "Only a promise," Lao Er said.
                                       Pearl S. Buck - Dragon Seed