Re: [PATCH 00/13] UAPI header file split

From: Michael Kerrisk
Date: Thu Jul 26 2012 - 10:35:48 EST


On Thu, Jul 26, 2012 at 4:32 PM, David Howells <dhowells@xxxxxxxxxx> wrote:
> Michael Kerrisk <mtk.manpages@xxxxxxxxx> wrote:
>
>> I've not checked whether any of the below are fixed in the adjustments
>> that you made in the last 20 hours (though it looks like at least some
>> of them are not), but a little scripting to check the content of the
>> split files showed that while most of them were okay, in the cases
>> below, some comment text was being discarded by the scripts.
>>
>> ./include/linux/irqnr.h ./include/uapi/linux/irqnr.h
>> ./arch/frv/include/asm/types.h ./arch/frv/include/uapi/asm/types.h
>> ./arch/cris/include/asm/types.h ./arch/cris/include/uapi/asm/types.h
>> ./arch/arm/include/asm/types.h ./arch/arm/include/uapi/asm/types.h
>> ./arch/sh/include/asm/types.h ./arch/sh/include/uapi/asm/types.h
>> ./arch/ia64/include/asm/kvm_para.h ./arch/ia64/include/uapi/asm/kvm_para.h
>> ./arch/mn10300/include/asm/types.h ./arch/mn10300/include/uapi/asm/types.h
>> ./arch/m68k/include/asm/types.h ./arch/m68k/include/uapi/asm/types.h
>> ./arch/avr32/include/asm/types.h ./arch/avr32/include/uapi/asm/types.h
>> ./arch/m32r/include/asm/types.h ./arch/m32r/include/uapi/asm/types.h
>>
>> I found these using the script below, which tries to check the
>> integrity of the transformations you are making with your scripts.
>> Other than the files above, the results looked good.
>
> How about the attached changes?
>
> I had to put in special handling for comments of the form:
>
> These aren't exported outside the kernel to avoid name space clashes
>
> because they invariably occur in the wrong section (ie. they would normally
> end up in the UAPI side).

I haven't looked over the changes yet, but what do my scripts now say?
(If all's well, they generate no output beyond the list of files.)

Cheers,

Michael


>
> I consulted Thomas Gleixner about irqnr.h. He says it doesn't matter if that
> one comment gets lost. Besides, something like that can be added back later,
> perhaps in a better place (it doesn't look like it's in the right place now).
>
> David
> ---
> diff --git a/arch/arm/include/asm/types.h b/arch/arm/include/asm/types.h
> index d73badf..01d8630 100644
> --- a/arch/arm/include/asm/types.h
> +++ b/arch/arm/include/asm/types.h
> @@ -3,6 +3,9 @@
>
> #include <uapi/asm/types.h>
>
> +/*
> + * These aren't exported outside the kernel to avoid name space clashes
> + */
>
> #define BITS_PER_LONG 32
>
> diff --git a/arch/avr32/include/asm/types.h b/arch/avr32/include/asm/types.h
> index cd34e33..5932405 100644
> --- a/arch/avr32/include/asm/types.h
> +++ b/arch/avr32/include/asm/types.h
> @@ -10,6 +10,9 @@
>
> #include <uapi/asm/types.h>
>
> +/*
> + * These aren't exported outside the kernel to avoid name space clashes
> + */
>
> #define BITS_PER_LONG 32
>
> diff --git a/arch/avr32/include/uapi/asm/types.h b/arch/avr32/include/uapi/asm/types.h
> index 9ec9d4c..bb34ad3 100644
> --- a/arch/avr32/include/uapi/asm/types.h
> +++ b/arch/avr32/include/uapi/asm/types.h
> @@ -1 +1,8 @@
> +/*
> + * Copyright (C) 2004-2006 Atmel Corporation
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License version 2 as
> + * published by the Free Software Foundation.
> + */
> #include <asm-generic/int-ll64.h>
> diff --git a/arch/cris/include/asm/types.h b/arch/cris/include/asm/types.h
> index 1964943..a3cac77 100644
> --- a/arch/cris/include/asm/types.h
> +++ b/arch/cris/include/asm/types.h
> @@ -3,6 +3,9 @@
>
> #include <uapi/asm/types.h>
>
> +/*
> + * These aren't exported outside the kernel to avoid name space clashes
> + */
>
> #define BITS_PER_LONG 32
>
> diff --git a/arch/frv/include/asm/types.h b/arch/frv/include/asm/types.h
> index 887a6cb..6bc6365 100644
> --- a/arch/frv/include/asm/types.h
> +++ b/arch/frv/include/asm/types.h
> @@ -13,6 +13,9 @@
>
> #include <uapi/asm/types.h>
>
> +/*
> + * These aren't exported outside the kernel to avoid name space clashes
> + */
>
> #define BITS_PER_LONG 32
>
> diff --git a/arch/frv/include/uapi/asm/types.h b/arch/frv/include/uapi/asm/types.h
> index 9ec9d4c..cf23149 100644
> --- a/arch/frv/include/uapi/asm/types.h
> +++ b/arch/frv/include/uapi/asm/types.h
> @@ -1 +1,11 @@
> +/* types.h: FRV types
> + *
> + * Copyright (C) 2004 Red Hat, Inc. All Rights Reserved.
> + * Written by David Howells (dhowells@xxxxxxxxxx)
> + *
> + * This program is free software; you can redistribute it and/or
> + * modify it under the terms of the GNU General Public License
> + * as published by the Free Software Foundation; either version
> + * 2 of the License, or (at your option) any later version.
> + */
> #include <asm-generic/int-ll64.h>
> diff --git a/arch/ia64/include/asm/types.h b/arch/ia64/include/asm/types.h
> index 2a7d1be..4c351b1 100644
> --- a/arch/ia64/include/asm/types.h
> +++ b/arch/ia64/include/asm/types.h
> @@ -18,6 +18,9 @@
>
> #ifdef __ASSEMBLY__
> #else
> +/*
> + * These aren't exported outside the kernel to avoid name space clashes
> + */
>
> struct fnptr {
> unsigned long ip;
> diff --git a/arch/ia64/include/uapi/asm/types.h b/arch/ia64/include/uapi/asm/types.h
> index c90f317..321193b 100644
> --- a/arch/ia64/include/uapi/asm/types.h
> +++ b/arch/ia64/include/uapi/asm/types.h
> @@ -26,9 +26,6 @@
> # define __IA64_UL(x) ((unsigned long)(x))
> # define __IA64_UL_CONST(x) x##UL
>
> -/*
> - * These aren't exported outside the kernel to avoid name space clashes
> - */
> #endif /* !__ASSEMBLY__ */
>
> #endif /* _UAPI_ASM_IA64_TYPES_H */
> diff --git a/arch/m32r/include/asm/types.h b/arch/m32r/include/asm/types.h
> index f456659..04a44c6 100644
> --- a/arch/m32r/include/asm/types.h
> +++ b/arch/m32r/include/asm/types.h
> @@ -3,6 +3,9 @@
>
> #include <uapi/asm/types.h>
>
> +/*
> + * These aren't exported outside the kernel to avoid name space clashes
> + */
>
> #define BITS_PER_LONG 32
>
> diff --git a/arch/m68k/include/asm/types.h b/arch/m68k/include/asm/types.h
> index 436ab02..80160f4 100644
> --- a/arch/m68k/include/asm/types.h
> +++ b/arch/m68k/include/asm/types.h
> @@ -3,6 +3,9 @@
>
> #include <uapi/asm/types.h>
>
> +/*
> + * These aren't exported outside the kernel to avoid name space clashes
> + */
>
> #define BITS_PER_LONG 32
>
> diff --git a/arch/mips/include/asm/types.h b/arch/mips/include/asm/types.h
> index 8d13ec5..a845aaf 100644
> --- a/arch/mips/include/asm/types.h
> +++ b/arch/mips/include/asm/types.h
> @@ -14,6 +14,9 @@
> # include <asm-generic/int-ll64.h>
> #include <uapi/asm/types.h>
>
> +/*
> + * These aren't exported outside the kernel to avoid name space clashes
> + */
> #ifndef __ASSEMBLY__
>
> /*
> diff --git a/arch/mips/include/uapi/asm/types.h b/arch/mips/include/uapi/asm/types.h
> index 6c65178..7ac9d0b 100644
> --- a/arch/mips/include/uapi/asm/types.h
> +++ b/arch/mips/include/uapi/asm/types.h
> @@ -23,8 +23,5 @@
> # endif
> #endif
>
> -/*
> - * These aren't exported outside the kernel to avoid name space clashes
> - */
>
> #endif /* _UAPI_ASM_TYPES_H */
> diff --git a/arch/mn10300/include/asm/types.h b/arch/mn10300/include/asm/types.h
> index c056756..3d6e483 100644
> --- a/arch/mn10300/include/asm/types.h
> +++ b/arch/mn10300/include/asm/types.h
> @@ -13,6 +13,9 @@
>
> #include <uapi/asm/types.h>
>
> +/*
> + * These aren't exported outside the kernel to avoid name space clashes
> + */
>
> #define BITS_PER_LONG 32
>
> diff --git a/arch/mn10300/include/uapi/asm/types.h b/arch/mn10300/include/uapi/asm/types.h
> index 9ec9d4c..8b3f050 100644
> --- a/arch/mn10300/include/uapi/asm/types.h
> +++ b/arch/mn10300/include/uapi/asm/types.h
> @@ -1 +1,11 @@
> +/* MN10300 Basic type definitions
> + *
> + * Copyright (C) 2007 Matsushita Electric Industrial Co., Ltd.
> + * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
> + *
> + * This program is free software; you can redistribute it and/or
> + * modify it under the terms of the GNU General Public Licence
> + * as published by the Free Software Foundation; either version
> + * 2 of the Licence, or (at your option) any later version.
> + */
> #include <asm-generic/int-ll64.h>
> diff --git a/arch/s390/include/asm/types.h b/arch/s390/include/asm/types.h
> index 876f016..36ec230 100644
> --- a/arch/s390/include/asm/types.h
> +++ b/arch/s390/include/asm/types.h
> @@ -10,6 +10,9 @@
>
> #include <uapi/asm/types.h>
>
> +/*
> + * These aren't exported outside the kernel to avoid name space clashes
> + */
>
> #ifndef __ASSEMBLY__
>
> diff --git a/arch/s390/include/uapi/asm/types.h b/arch/s390/include/uapi/asm/types.h
> index 9d177d4..04a07a2 100644
> --- a/arch/s390/include/uapi/asm/types.h
> +++ b/arch/s390/include/uapi/asm/types.h
> @@ -21,7 +21,4 @@ typedef __signed__ long saddr_t;
>
> #endif /* __ASSEMBLY__ */
>
> -/*
> - * These aren't exported outside the kernel to avoid name space clashes
> - */
> #endif /* _UAPI_S390_TYPES_H */
> diff --git a/arch/sh/include/asm/types.h b/arch/sh/include/asm/types.h
> index 8315c99..6a31053 100644
> --- a/arch/sh/include/asm/types.h
> +++ b/arch/sh/include/asm/types.h
> @@ -3,6 +3,9 @@
>
> #include <uapi/asm/types.h>
>
> +/*
> + * These aren't exported outside the kernel to avoid name space clashes
> + */
> #ifndef __ASSEMBLY__
>
> #ifdef CONFIG_SUPERH32
> diff --git a/arch/xtensa/include/asm/types.h b/arch/xtensa/include/asm/types.h
> index dd2a269..2b410b8 100644
> --- a/arch/xtensa/include/asm/types.h
> +++ b/arch/xtensa/include/asm/types.h
> @@ -13,6 +13,9 @@
> #include <uapi/asm/types.h>
>
> #ifndef __ASSEMBLY__
> +/*
> + * These aren't exported outside the kernel to avoid name space clashes
> + */
>
> #define BITS_PER_LONG 32
>
> diff --git a/arch/xtensa/include/uapi/asm/types.h b/arch/xtensa/include/uapi/asm/types.h
> index 2293432..87ec7ae 100644
> --- a/arch/xtensa/include/uapi/asm/types.h
> +++ b/arch/xtensa/include/uapi/asm/types.h
> @@ -23,9 +23,6 @@
>
> #ifndef __ASSEMBLY__
>
> -/*
> - * These aren't exported outside the kernel to avoid name space clashes
> - */
> #endif
>
> #endif /* _UAPI_XTENSA_TYPES_H */
> --
> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at http://vger.kernel.org/majordomo-info.html
> Please read the FAQ at http://www.tux.org/lkml/



--
Michael Kerrisk Linux man-pages maintainer;
http://www.kernel.org/doc/man-pages/
Author of "The Linux Programming Interface", http://blog.man7.org/
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/