aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGeert Uytterhoeven <geert@linux-m68k.org>2014-08-08 11:23:10 -0400
committerMichal Marek <mmarek@suse.cz>2014-08-19 04:02:56 -0400
commit39fed7015cd9124b5893fce18d33f49db1c48bea (patch)
treedc9494eac710c0f88d81d58aadf3d72784d8b736
parentcf6c53db9525a7f6c5052ccd84a0638128f14632 (diff)
Documentation: kbuild: Improve grammar
- singular versus plural, - "by" versus "of", - missing "if", "it", "the", - consistent use of "xxx-specific" versus "xxx specific". Signed-off-by: Geert Uytterhoeven <geert@linux-m68k.org> Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Michal Marek <mmarek@suse.cz>
-rw-r--r--Documentation/kbuild/makefiles.txt56
1 files changed, 28 insertions, 28 deletions
diff --git a/Documentation/kbuild/makefiles.txt b/Documentation/kbuild/makefiles.txt
index eda00a1073a7..a311db829e9b 100644
--- a/Documentation/kbuild/makefiles.txt
+++ b/Documentation/kbuild/makefiles.txt
@@ -174,7 +174,7 @@ more details, with real examples.
174 174
175--- 3.3 Loadable module goals - obj-m 175--- 3.3 Loadable module goals - obj-m
176 176
177 $(obj-m) specify object files which are built as loadable 177 $(obj-m) specifies object files which are built as loadable
178 kernel modules. 178 kernel modules.
179 179
180 A module may be built from one source file or several source 180 A module may be built from one source file or several source
@@ -277,7 +277,7 @@ more details, with real examples.
277 down in the ext2 directory. 277 down in the ext2 directory.
278 Kbuild only uses this information to decide that it needs to visit 278 Kbuild only uses this information to decide that it needs to visit
279 the directory, it is the Makefile in the subdirectory that 279 the directory, it is the Makefile in the subdirectory that
280 specifies what is modules and what is built-in. 280 specifies what is modular and what is built-in.
281 281
282 It is good practice to use a CONFIG_ variable when assigning directory 282 It is good practice to use a CONFIG_ variable when assigning directory
283 names. This allows kbuild to totally skip the directory if the 283 names. This allows kbuild to totally skip the directory if the
@@ -403,7 +403,7 @@ more details, with real examples.
403 echoing information to user in a rule is often a good practice 403 echoing information to user in a rule is often a good practice
404 but when execution "make -s" one does not expect to see any output 404 but when execution "make -s" one does not expect to see any output
405 except for warnings/errors. 405 except for warnings/errors.
406 To support this kbuild define $(kecho) which will echo out the 406 To support this kbuild defines $(kecho) which will echo out the
407 text following $(kecho) to stdout except if "make -s" is used. 407 text following $(kecho) to stdout except if "make -s" is used.
408 408
409 Example: 409 Example:
@@ -417,7 +417,7 @@ more details, with real examples.
417 417
418 The kernel may be built with several different versions of 418 The kernel may be built with several different versions of
419 $(CC), each supporting a unique set of features and options. 419 $(CC), each supporting a unique set of features and options.
420 kbuild provide basic support to check for valid options for $(CC). 420 kbuild provides basic support to check for valid options for $(CC).
421 $(CC) is usually the gcc compiler, but other alternatives are 421 $(CC) is usually the gcc compiler, but other alternatives are
422 available. 422 available.
423 423
@@ -456,8 +456,8 @@ more details, with real examples.
456 Note: as-instr-option uses KBUILD_AFLAGS for $(AS) options 456 Note: as-instr-option uses KBUILD_AFLAGS for $(AS) options
457 457
458 cc-option 458 cc-option
459 cc-option is used to check if $(CC) supports a given option, and not 459 cc-option is used to check if $(CC) supports a given option, and if
460 supported to use an optional second option. 460 not supported to use an optional second option.
461 461
462 Example: 462 Example:
463 #arch/x86/Makefile 463 #arch/x86/Makefile
@@ -557,8 +557,8 @@ more details, with real examples.
557 false ; \ 557 false ; \
558 fi 558 fi
559 559
560 In this example for a specific GCC version the build will error out explaining 560 In this example for a specific GCC version the build will error out
561 to the user why it stops. 561 explaining to the user why it stops.
562 562
563 cc-cross-prefix 563 cc-cross-prefix
564 cc-cross-prefix is used to check if there exists a $(CC) in path with 564 cc-cross-prefix is used to check if there exists a $(CC) in path with
@@ -656,7 +656,7 @@ Both possibilities are described in the following.
656 In the example above the executable is composed of the C++ file 656 In the example above the executable is composed of the C++ file
657 qconf.cc - identified by $(qconf-cxxobjs). 657 qconf.cc - identified by $(qconf-cxxobjs).
658 658
659 If qconf is composed by a mixture of .c and .cc files, then an 659 If qconf is composed of a mixture of .c and .cc files, then an
660 additional line can be used to identify this. 660 additional line can be used to identify this.
661 661
662 Example: 662 Example:
@@ -733,7 +733,7 @@ Both possibilities are described in the following.
733 hostprogs-$(CONFIG_KALLSYMS) += kallsyms 733 hostprogs-$(CONFIG_KALLSYMS) += kallsyms
734 734
735 Kbuild knows about both 'y' for built-in and 'm' for module. 735 Kbuild knows about both 'y' for built-in and 'm' for module.
736 So if a config symbol evaluate to 'm', kbuild will still build 736 So if a config symbol evaluates to 'm', kbuild will still build
737 the binary. In other words, Kbuild handles hostprogs-m exactly 737 the binary. In other words, Kbuild handles hostprogs-m exactly
738 like hostprogs-y. But only hostprogs-y is recommended to be used 738 like hostprogs-y. But only hostprogs-y is recommended to be used
739 when no CONFIG symbols are involved. 739 when no CONFIG symbols are involved.
@@ -754,8 +754,8 @@ Additional files can be specified in kbuild makefiles by use of $(clean-files).
754 #drivers/pci/Makefile 754 #drivers/pci/Makefile
755 clean-files := devlist.h classlist.h 755 clean-files := devlist.h classlist.h
756 756
757When executing "make clean", the two files "devlist.h classlist.h" will 757When executing "make clean", the two files "devlist.h classlist.h" will be
758be deleted. Kbuild will assume files to be in same relative directory as the 758deleted. Kbuild will assume files to be in the same relative directory as the
759Makefile except if an absolute path is specified (path starting with '/'). 759Makefile except if an absolute path is specified (path starting with '/').
760 760
761To delete a directory hierarchy use: 761To delete a directory hierarchy use:
@@ -786,7 +786,7 @@ is not sufficient this sometimes needs to be explicit.
786The above assignment instructs kbuild to descend down in the 786The above assignment instructs kbuild to descend down in the
787directory compressed/ when "make clean" is executed. 787directory compressed/ when "make clean" is executed.
788 788
789To support the clean infrastructure in the Makefiles that builds the 789To support the clean infrastructure in the Makefiles that build the
790final bootimage there is an optional target named archclean: 790final bootimage there is an optional target named archclean:
791 791
792 Example: 792 Example:
@@ -926,7 +926,7 @@ When kbuild executes, the following steps are followed (roughly):
926 926
927 KBUILD_AFLAGS_MODULE Options for $(AS) when building modules 927 KBUILD_AFLAGS_MODULE Options for $(AS) when building modules
928 928
929 $(KBUILD_AFLAGS_MODULE) is used to add arch specific options that 929 $(KBUILD_AFLAGS_MODULE) is used to add arch-specific options that
930 are used for $(AS). 930 are used for $(AS).
931 From commandline AFLAGS_MODULE shall be used (see kbuild.txt). 931 From commandline AFLAGS_MODULE shall be used (see kbuild.txt).
932 932
@@ -937,13 +937,13 @@ When kbuild executes, the following steps are followed (roughly):
937 937
938 KBUILD_CFLAGS_MODULE Options for $(CC) when building modules 938 KBUILD_CFLAGS_MODULE Options for $(CC) when building modules
939 939
940 $(KBUILD_CFLAGS_MODULE) is used to add arch specific options that 940 $(KBUILD_CFLAGS_MODULE) is used to add arch-specific options that
941 are used for $(CC). 941 are used for $(CC).
942 From commandline CFLAGS_MODULE shall be used (see kbuild.txt). 942 From commandline CFLAGS_MODULE shall be used (see kbuild.txt).
943 943
944 KBUILD_LDFLAGS_MODULE Options for $(LD) when linking modules 944 KBUILD_LDFLAGS_MODULE Options for $(LD) when linking modules
945 945
946 $(KBUILD_LDFLAGS_MODULE) is used to add arch specific options 946 $(KBUILD_LDFLAGS_MODULE) is used to add arch-specific options
947 used when linking modules. This is often a linker script. 947 used when linking modules. This is often a linker script.
948 From commandline LDFLAGS_MODULE shall be used (see kbuild.txt). 948 From commandline LDFLAGS_MODULE shall be used (see kbuild.txt).
949 949
@@ -1065,7 +1065,7 @@ When kbuild executes, the following steps are followed (roughly):
1065 1065
1066 extra-y 1066 extra-y
1067 1067
1068 extra-y specify additional targets created in the current 1068 extra-y specifies additional targets created in the current
1069 directory, in addition to any targets specified by obj-*. 1069 directory, in addition to any targets specified by obj-*.
1070 1070
1071 Listing all targets in extra-y is required for two purposes: 1071 Listing all targets in extra-y is required for two purposes:
@@ -1141,7 +1141,7 @@ When kbuild executes, the following steps are followed (roughly):
1141 2) delete target during make clean 1141 2) delete target during make clean
1142 1142
1143 The ": %: %.o" part of the prerequisite is a shorthand that 1143 The ": %: %.o" part of the prerequisite is a shorthand that
1144 free us from listing the setup.o and bootsect.o files. 1144 frees us from listing the setup.o and bootsect.o files.
1145 Note: It is a common mistake to forget the "targets :=" assignment, 1145 Note: It is a common mistake to forget the "targets :=" assignment,
1146 resulting in the target file being recompiled for no 1146 resulting in the target file being recompiled for no
1147 obvious reason. 1147 obvious reason.
@@ -1213,11 +1213,11 @@ When kbuild executes, the following steps are followed (roughly):
1213 When building the *.lds target, kbuild uses the variables: 1213 When building the *.lds target, kbuild uses the variables:
1214 KBUILD_CPPFLAGS : Set in top-level Makefile 1214 KBUILD_CPPFLAGS : Set in top-level Makefile
1215 cppflags-y : May be set in the kbuild makefile 1215 cppflags-y : May be set in the kbuild makefile
1216 CPPFLAGS_$(@F) : Target specific flags. 1216 CPPFLAGS_$(@F) : Target-specific flags.
1217 Note that the full filename is used in this 1217 Note that the full filename is used in this
1218 assignment. 1218 assignment.
1219 1219
1220 The kbuild infrastructure for *lds file are used in several 1220 The kbuild infrastructure for *lds files is used in several
1221 architecture-specific files. 1221 architecture-specific files.
1222 1222
1223--- 6.10 Generic header files 1223--- 6.10 Generic header files
@@ -1230,11 +1230,11 @@ When kbuild executes, the following steps are followed (roughly):
1230 1230
1231=== 7 Kbuild syntax for exported headers 1231=== 7 Kbuild syntax for exported headers
1232 1232
1233The kernel include a set of headers that is exported to userspace. 1233The kernel includes a set of headers that is exported to userspace.
1234Many headers can be exported as-is but other headers require a 1234Many headers can be exported as-is but other headers require a
1235minimal pre-processing before they are ready for user-space. 1235minimal pre-processing before they are ready for user-space.
1236The pre-processing does: 1236The pre-processing does:
1237- drop kernel specific annotations 1237- drop kernel-specific annotations
1238- drop include of compiler.h 1238- drop include of compiler.h
1239- drop all sections that are kernel internal (guarded by ifdef __KERNEL__) 1239- drop all sections that are kernel internal (guarded by ifdef __KERNEL__)
1240 1240
@@ -1244,7 +1244,7 @@ See subsequent chapter for the syntax of the Kbuild file.
1244 1244
1245 --- 7.1 header-y 1245 --- 7.1 header-y
1246 1246
1247 header-y specify header files to be exported. 1247 header-y specifies header files to be exported.
1248 1248
1249 Example: 1249 Example:
1250 #include/linux/Kbuild 1250 #include/linux/Kbuild
@@ -1254,7 +1254,7 @@ See subsequent chapter for the syntax of the Kbuild file.
1254 The convention is to list one file per line and 1254 The convention is to list one file per line and
1255 preferably in alphabetic order. 1255 preferably in alphabetic order.
1256 1256
1257 header-y also specify which subdirectories to visit. 1257 header-y also specifies which subdirectories to visit.
1258 A subdirectory is identified by a trailing '/' which 1258 A subdirectory is identified by a trailing '/' which
1259 can be seen in the example above for the usb subdirectory. 1259 can be seen in the example above for the usb subdirectory.
1260 1260
@@ -1272,9 +1272,9 @@ See subsequent chapter for the syntax of the Kbuild file.
1272 1272
1273 --- 7.3 destination-y 1273 --- 7.3 destination-y
1274 1274
1275 When an architecture have a set of exported headers that needs to be 1275 When an architecture has a set of exported headers that needs to be
1276 exported to a different directory destination-y is used. 1276 exported to a different directory destination-y is used.
1277 destination-y specify the destination directory for all exported 1277 destination-y specifies the destination directory for all exported
1278 headers in the file where it is present. 1278 headers in the file where it is present.
1279 1279
1280 Example: 1280 Example:
@@ -1367,9 +1367,9 @@ The top Makefile exports the following variables:
1367 1367
1368 INSTALL_MOD_STRIP 1368 INSTALL_MOD_STRIP
1369 1369
1370 If this variable is specified, will cause modules to be stripped 1370 If this variable is specified, it will cause modules to be stripped
1371 after they are installed. If INSTALL_MOD_STRIP is '1', then the 1371 after they are installed. If INSTALL_MOD_STRIP is '1', then the
1372 default option --strip-debug will be used. Otherwise, 1372 default option --strip-debug will be used. Otherwise, the
1373 INSTALL_MOD_STRIP value will be used as the option(s) to the strip 1373 INSTALL_MOD_STRIP value will be used as the option(s) to the strip
1374 command. 1374 command.
1375 1375