aio: fix wrong subsystem comments
Subsystems (4)
PATCH 1/7 aio: fix wrong subsystem comments
From: Satoru Takeuchi <[email protected]>
Hi Benjamin and aio guys,
I fixed wrong comments on the aio subsystem. Although it causes no binary change, I confirmed the kernel applying this patch can boot on my i386 box.
Since I doesn't subscribe this list, please Cc me if you reply this mail.
Thanks,
Satoru
---
Fix wrong comments on the aio subsystem.
- sys_io_destroy(): acutually return -EINVAL if the context pointed to is invalidIndex: linux-2.6.33-rc4/fs/aio.c
- sys_io_getevents(): An argument specifying timeout is not when', but timeout'.
- sys_io_getevents(): Should describe what is returned if this syscall succeeds.
--- fs/aio.c | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-)
fs/aio.c +11 -10
@@ -1277,7 +1277,7 @@ out:/* sys_io_destroy: * Destroy the aio_context specified. May cancel any outstanding * AIOs and block on completion. Will fail with -ENOSYS if not -* implemented. May fail with -EFAULT if the context pointed to +* implemented. May fail with -EINVAL if the context pointed to * is invalid. */ SYSCALL_DEFINE1 (io_destroy, aio_context_t, ctx)
@@ -1795,15 +1795,16 @@ SYSCALL_DEFINE3(io_cancel, aio_context_t/* io_getevents: * Attempts to read at least min_nr events and up to nr events from -* the completion queue for the aio_context specified by ctx_id. May -* fail with -EINVAL if ctx_id is invalid, if min_nr is out of range, -* if nr is out of range, if when is out of range. May fail with -* -EFAULT if any of the memory specified to is invalid. May return -* 0 or < min_nr if no events are available and the timeout specified -* by when has elapsed, where when == NULL specifies an infinite -* timeout. Note that the timeout pointed to by when is relative and -* will be updated if not NULL and the operation blocks. Will fail -* with -ENOSYS if not implemented. +* the completion queue for the aio_context specified by ctx_id. If +* it succeeds, the number of read events is returned. May fail with +* -EINVAL if ctx_id is invalid, if min_nr is out of range, if nr is +* out of range, if timeout is out of range. May fail with -EFAULT +* if any of the memory specified is invalid. May return 0 or +* < min_nr if the timeout specified by timeout has elapsed +* before sufficient events are available, where timeout == NULL +* specifies an infinite timeout. Note that the timeout pointed to by +* timeout is relative and will be updated if not NULL and the +* operation blocks. Will fail with -ENOSYS if not implemented. */ SYSCALL_DEFINE5(io_getevents, aio_context_t, ctx_id, long, min_nr,
PATCH 6/7 Documentation: fix kbuild typos and wording
From: Nicolas Kaiser <[email protected]>
Fixed some typos and wording.
--- Documentation/kbuild/kbuild.txt | 8 ++++---- Documentation/kbuild/makefiles.txt | 24 ++++++++++++------------ 2 files changed, 16 insertions(+), 16 deletions(-)
Documentation/kbuild/kbuild.txt +4 -4
@@ -40,15 +40,15 @@ Set the directory to look for the kernel modules. The directory can be specified in several ways: 1) Use "M=..." on the command line -2) Environmnet variable KBUILD_EXTMOD -3) Environmnet variable SUBDIRS +2) Environment variable KBUILD_EXTMOD +3) Environment variable SUBDIRS The possibilities are listed in the order they take precedence. Using "M=..." will always override the others. KBUILD_OUTPUT -------------------------------------------------- Specify the output directory when building the kernel. -The output directory can also be specificed using "O=...". +The output directory can also be specified using "O=...". Setting "O=..." takes precedence over KBUILD_OUTPUT. ARCH
@@ -90,7 +90,7 @@ The script will be called with the follo $3 - kernel map file $4 - default install path (use root directory if blank) -The implmentation of "make install" is architecture specific +The implementation of "make install" is architecture specific and it may differ from the above. INSTALLKERNEL is provided to enable the possibility to
Documentation/kbuild/makefiles.txt +12 -12
@@ -285,12 +285,12 @@ more details, with real examples. --- 3.7 Compilation flags ccflags-y, asflags-y and ldflags-y - The three flags listed above apply only to the kbuild makefile where - they are assigned (i.e., per-directory). They are used for all the - normal cc, as and ld invocation happening during a recursive build. + These three flags apply only to the kbuild makefile in which they + are assigned. They are used for all the normal cc, as and ld + invocations happening during a recursive build. Note: Flags with the same behaviour were previously named: - EXTRA_CFLAGS, EXTRA_AFLAGS and EXTRA_LDFLAGS. They are still - supported but their use is deprecated. + EXTRA_CFLAGS, EXTRA_AFLAGS and EXTRA_LDFLAGS. + They are still supported but their usage is deprecated. ccflags-y specifies options for compiling with $(CC).
@@ -317,10 +317,10 @@ more details, with real examples. subdir-ccflags-y, subdir-asflags-y The two flags listed above are similar to ccflags-y and asflags-y. - The difference is that the subdir- variants affect the kbuild - file where they are present and all subdirectories. Options specified - using subdir-* are added to the commandline before the options - specified using the non-subdir variants. + The difference is that the subdir- variants have effect for the kbuild + file where they are present and all subdirectories. + Options specified using subdir-* are added to the commandline before + the options specified using the non-subdir variants. Example: subdir-ccflags-y := -Werror
@@ -1174,14 +1174,14 @@ When kbuild executes, the following step === 7 Kbuild syntax for exported headers The kernel include a set of headers that is exported to userspace. -Many headers can be exported as-is but other headers requires a +Many headers can be exported as-is but other headers require a minimal pre-processing before they are ready for user-space. The pre-processing does: - drop kernel specific annotations - drop include of compiler.h -- drop all sections that is kernel internat (guarded by ifdef __KERNEL__) +- drop all sections that are kernel internal (guarded by ifdef __KERNEL__) -Each relevant directory contain a file name "Kbuild" which specify the +Each relevant directory contains a file name "Kbuild" which specifies the headers to be exported. See subsequent chapter for the syntax of the Kbuild file.
PATCH 3/7 Documentation: update kbuild loadable modules goals & examples
In reply to Randy DunlapFrom: matt mooney <[email protected]>
Update section 3.3 Loadable module goals - obj-m, from $(<module_name>-objs) to $(<module_name>-y) for easier addition of conditional objects to the module. The examples are also updated to reflect the current state of each Makefile used.
---
Documentation/kbuild/makefiles.txt | 37 +++++++++++++-------------- 1 file changed, 19 insertions(+), 18 deletions(-)
Documentation/kbuild/makefiles.txt +19 -18
@@ -187,34 +187,35 @@ more details, with real examples. Note: In this example $(CONFIG_ISDN_PPP_BSDCOMP) evaluates to 'm' If a kernel module is built from several source files, you specify - that you want to build a module in the same way as above. - - Kbuild needs to know which the parts that you want to build your - module from, so you have to tell it by setting an - $(<module_name>-objs) variable. + that you want to build a module in the same way as above; however, + kbuild needs to know which object files you want to build your + module from, so you have to tell it by setting a $(<module_name>-y) + variable. Example: #drivers/isdn/i4l/Makefile - obj-$(CONFIG_ISDN) += isdn.o - isdn-objs := isdn_net_lib.o isdn_v110.o isdn_common.o + obj-$(CONFIG_ISDN_I4L) += isdn.o + isdn-y := isdn_net_lib.o isdn_v110.o isdn_common.o In this example, the module name will be isdn.o. Kbuild will - compile the objects listed in $(isdn-objs) and then run + compile the objects listed in $(isdn-y) and then run "$(LD) -r" on the list of these files to generate isdn.o. - Kbuild recognises objects used for composite objects by the suffix - -objs, and the suffix -y. This allows the Makefiles to use - the value of a CONFIG_ symbol to determine if an object is part - of a composite object. + Due to kbuild recognizing $(<module_name>-y) for composite objects, + you can use the value of a CONFIG_ symbol to optionally include an + object file as part of a composite object. Example: #fs/ext2/Makefile - obj-$(CONFIG_EXT2_FS) += ext2.o - ext2-y := balloc.o bitmap.o - ext2-$(CONFIG_EXT2_FS_XATTR) += xattr.o - - In this example, xattr.o is only part of the composite object - ext2.o if $(CONFIG_EXT2_FS_XATTR) evaluates to 'y'. + obj-$(CONFIG_EXT2_FS) += ext2.o + ext2-y := balloc.o dir.o file.o ialloc.o inode.o ioctl.o \ + namei.o super.o symlink.o + ext2-$(CONFIG_EXT2_FS_XATTR) += xattr.o xattr_user.o \ + xattr_trusted.o + + In this example, xattr.o, xattr_user.o and xattr_trusted.o are only + part of the composite object ext2.o if $(CONFIG_EXT2_FS_XATTR) + evaluates to 'y'. Note: Of course, when you are building objects into the kernel, the syntax above will also work. So, if you have CONFIG_EXT2_FS=y,
PATCH 5/7 Documentation: update kbuild make typos/grammar/text flow
In reply to Randy DunlapFrom: matt mooney <[email protected]>
Update section 3.7 examples to reflect the current state of the Makefiles used. Fix spelling and grammar errors along with flow of text.
---
Documentation/kbuild/makefiles.txt | 53 ++++++++++++--------------- 1 file changed, 25 insertions(+), 28 deletions(-)
Documentation/kbuild/makefiles.txt +25 -28
@@ -285,45 +285,42 @@ more details, with real examples. --- 3.7 Compilation flags ccflags-y, asflags-y and ldflags-y - The three flags listed above applies only to the kbuild makefile - where they are assigned. They are used for all the normal - cc, as and ld invocation happenign during a recursive build. + The three flags listed above apply only to the kbuild makefile where + they are assigned (i.e., per-directory). They are used for all the + normal cc, as and ld invocation happening during a recursive build. Note: Flags with the same behaviour were previously named: - EXTRA_CFLAGS, EXTRA_AFLAGS and EXTRA_LDFLAGS. - They are yet supported but their use are deprecated. + EXTRA_CFLAGS, EXTRA_AFLAGS and EXTRA_LDFLAGS. They are still + supported but their use is deprecated. - ccflags-y specifies options for compiling C files with $(CC). + ccflags-y specifies options for compiling with $(CC). Example: - # drivers/sound/emu10k1/Makefile - ccflags-y += -I$(obj) - ccflags-$(DEBUG) += -DEMU10K1_DEBUG - + # drivers/acpi/Makefile + ccflags-y := -Os + ccflags-$(CONFIG_ACPI_DEBUG) += -DACPI_DEBUG_OUTPUT This variable is necessary because the top Makefile owns the variable $(KBUILD_CFLAGS) and uses it for compilation flags for the entire tree. - asflags-y is a similar string for per-directory options - when compiling assembly language source. + asflags-y specifies options for assembling with $(AS). Example: - #arch/x86_64/kernel/Makefile - asflags-y := -traditional - + #arch/sparc/kernel/Makefile + asflags-y := -ansi - ldflags-y is a string for per-directory options to $(LD). + ldflags-y specifies options for linking with $(LD). Example: - #arch/m68k/fpsp040/Makefile - ldflags-y := -x + #arch/cris/boot/compressed/Makefile + ldflags-y += -T $(srctree)/$(src)/decompress_$(arch-y).lds subdir-ccflags-y, subdir-asflags-y - The two flags listed above are similar to ccflags-y and as-falgs-y. - The difference is that the subdir- variants has effect for the kbuild - file where tey are present and all subdirectories. - Options specified using subdir-* are added to the commandline before - the options specified using the non-subdir variants. + The two flags listed above are similar to ccflags-y and asflags-y. + The difference is that the subdir- variants affect the kbuild + file where they are present and all subdirectories. Options specified + using subdir-* are added to the commandline before the options + specified using the non-subdir variants. Example: subdir-ccflags-y := -Werror
@@ -341,18 +338,18 @@ more details, with real examples. CFLAGS_aha152x.o = -DAHA152X_STAT -DAUTOCONF CFLAGS_gdth.o = # -DDEBUG_GDTH=2 -D__SERIAL__ -D__COM2__ \ -DGDTH_STATISTICS - CFLAGS_seagate.o = -DARBITRATE -DPARITY -DSEAGATE_USE_ASM - These three lines specify compilation flags for aha152x.o, - gdth.o, and seagate.o + These two lines specify compilation flags for aha152x.o and gdth.o. $(AFLAGS_$@) is a similar feature for source files in assembly languages. Example: # arch/arm/kernel/Makefile - AFLAGS_head-armv.o := -DTEXTADDR=$(TEXTADDR) -traditional - AFLAGS_head-armo.o := -DTEXTADDR=$(TEXTADDR) -traditional + AFLAGS_head.o := -DTEXT_OFFSET=$(TEXT_OFFSET) + AFLAGS_crunch-bits.o := -Wa,-mcpu=ep9312 + AFLAGS_iwmmxt.o := -Wa,-mcpu=iwmmxt + --- 3.9 Dependency tracking
PATCH 2/7 Documentation/vm: fix spelling in page-types.c
In reply to Randy DunlapFrom: Tommi Rantala <[email protected]>
Trivial typo fixes.
--- Documentation/vm/page-types.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/vm/page-types.c +1 -1
@@ -694,7 +694,7 @@ static void usage(void)#endif " -l|--list Show page details in ranges\n" " -L|--list-each Show page details one by one\n" -" -N|--no-summary Don't show summay info\n" +" -N|--no-summary Don't show summary info\n" " -X|--hwpoison hwpoison pages\n" " -x|--unpoison unpoison pages\n" " -h|--help Show this usage message\n"
PATCH 4/7 Documentation: update kbuild make examples#2 to reflect changes
In reply to Randy DunlapFrom: matt mooney <[email protected]>
Update section 3.2 and 3.5 example, along with text in section 3.5 to reflect change.
---
Documentation/kbuild/makefiles.txt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
Documentation/kbuild/makefiles.txt +6 -6
@@ -168,7 +168,7 @@ more details, with real examples. #drivers/isdn/i4l/Makefile # Makefile for the kernel ISDN subsystem and device drivers. # Each configuration option enables a list of files. - obj-$(CONFIG_ISDN) += isdn.o + obj-$(CONFIG_ISDN_I4L) += isdn.o obj-$(CONFIG_ISDN_PPP_BSDCOMP) += isdn_bsdcomp.o --- 3.3 Loadable module goals - obj-m
@@ -245,12 +245,12 @@ more details, with real examples. may contain both a built-in.o and a lib.a file. Example: - #arch/i386/lib/Makefile - lib-y := checksum.o delay.o + #arch/x86/lib/Makefile + lib-y := delay.o - This will create a library lib.a based on checksum.o and delay.o. - For kbuild to actually recognize that there is a lib.a being built, - the directory shall be listed in libs-y. + This will create a library lib.a based on delay.o. For kbuild to + actually recognize that there is a lib.a being built, the directory + shall be listed in libs-y. See also "6.3 List directories to visit when descending". Use of lib-y is normally restricted to lib/ and arch/*/lib.
PATCH 7/7 docbook: use IDs as filenames to support multiple books
In reply to Randy DunlapFrom: Johannes Berg <[email protected]>
I'm trying to generate a <set> of <book>s in docbook for wireless to link together all the cfg80211 and mac80211 documentation.
However, docbook will generate "re01.html" anew for each book for the first <refentry>, presumably due to a bug in the stylesheets.
An effective workaround is to use IDs for the filenames, which makes them more descriptive as well, e.g. API-enum-ieee80211-band.html.
--- Documentation/DocBook/stylesheet.xsl | 1 + 1 file changed, 1 insertion(+)
Documentation/DocBook/stylesheet.xsl +1 -0
@@ -6,4 +6,5 @@ <param name="callout.graphics">0</param> <!-- <param name="paper.type">A4</param> --> <param name="generate.section.toc.level">2</param> +<param name="use.id.as.filename">1</param> </stylesheet>