Skip to contentSkip to conversation

kbuild/makefiles.txt: Fix examples and content

PATCH In review matt mooney 3 participants 5 messages May 11, 2010 – May 25, 2010

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/3 kbuild/makefiles.txt: Fix examples and content

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.

---
v2: Changes are the same, added [email protected] to list of recipients.

 Documentation/kbuild/makefiles.txt |   37 ++++++++++++++++++-----------------
 1 files changed, 19 insertions(+), 18 deletions(-)
Documentation/kbuild/makefiles.txt +19 -18
index 71c602d..b25507d 100644
@@ -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,

--
1.6.6.1

Reviewed-by on v2 1/3
#1 lore raw
Quoted 4 lines · matt mooney

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.

The whole patchset looks good to me, so,

But note that I am not a native English-speaker, let's see what Randy will say.

Thanks.

#2 lore raw

Hi Randy,

Should I resubmit these and include the main list? Or just forget about them?

Thanks,
matt

Quoted 7 lines · Américo Wang
Quoted 4 lines · matt mooney

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.

Quoted 9 lines

The whole patchset looks good to me, so,

But note that I am not a native English-speaker, let's see what Randy will say.

Thanks.

--
To unsubscribe from this list: send the line "unsubscribe kernel-janitors" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

#3 lore raw
Quoted 4 lines · On Tue, 18 May 2010 16:15:58 -0700 matt mooney wrote:

Hi Randy,

Should I resubmit these and include the main list? Or just forget about them?

Hi Matt,
You should remind me about them.
I'll take care of them. Thanks.

Quoted 18 lines

Thanks,
matt

Quoted 14 lines · Américo Wang
Quoted 4 lines · matt mooney

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.

The whole patchset looks good to me, so,

But note that I am not a native English-speaker, let's see what Randy will say.

Quoted 6 lines
Quoted 2 lines

Thanks.

--
To unsubscribe from this list: send the line "unsubscribe kernel-janitors" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code *** --
To unsubscribe from this list: send the line "unsubscribe kernel-janitors" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

#4 lore raw
In reply to Américo Wang
Quoted 7 lines · On Wed, 12 May 2010 12:30:38 +0800 Américo Wang wrote:
Quoted 4 lines · matt mooney

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.

Quoted 6 lines

The whole patchset looks good to me, so,

But note that I am not a native English-speaker, let's see what Randy will say.

Added all 3 patches to my patch queue. Thanks, Matt.

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code *** --
To unsubscribe from this list: send the line "unsubscribe kernel-janitors" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html