Skip to contentSkip to conversation

Typos in Documation/kbuild/modules.txt 2.6.15-rc2

PATCH In review Kristian Edlund 3 participants 4 messages Nov 22, 2005

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Typos in Documation/kbuild/modules.txt 2.6.15-rc2

From: Kristian Edlund <[email protected]>

I found a few typos, in Documentation/kbuild/modules.txt
I also changes the $PWD to pwd for consistency throughout the document.

---

I am not sure this is the right place to post, but now I am trying anyway. If I am completly wrong and changes to documentation should not be sent here, could please help me a bit with where I should send it.

kbuild/modules.txt 2005-11-22 03:11:13.000000000 +0100 renamed from kbuild/modules.txt.orig 2005-11-22 03:47:12.000000000 +0100 +0 -0
@@ -38,8 +38,8 @@ included in the kernel tree.

What is covered within this file is mainly information to authors of modules. The author of an external modules should supply a makefile that hides most of the complexity so one only has to type -'make' to buld the module. A complete example will be present in -chapter ¤. Creating a kbuild file for an external module". +'make' to build the module. A complete example will be present in +chapter 4. Creating a kbuild file for an external module".

=== 2. How to build external modules
@@ -84,14 +84,14 @@ when building an external module.
Same functionality as if no target was specified. See description above.

- make -C $KDIR M=$PWD modules_install
+ make -C $KDIR M=pwd modules_install
Install the external module(s).
Installation default is in /lib/modules/<kernel-version>/extra,
- but may be prefixed with INSTALL_MOD_PATH - see separate chater.
+ but may be prefixed with INSTALL_MOD_PATH - see separate chapter.

- make -C $KDIR M=$PWD clean
+ make -C $KDIR M=pwd clean
Remove all generated files for the module - the kernel
- source directory is not moddified.
+ source directory is not modified.

make -C $KDIR M=pwd help
help will list the available target when building external
@@ -99,8 +99,6 @@ when building an external module.

--- 2.3 Available options:

- $KDIR refer to path to kernel src
-
make -C $KDIR
Used to specify where to find the kernel source. '$KDIR' represent the directory where the kernel source is.
@@ -341,7 +339,7 @@ directory and therefore needs to deal wi
EXTRA_CFLAGS := -Iinclude
8123-y := 8123_if.o 8123_pci.o 8123_bin.o

- Note that in the assingment there is no space between -I and the path.
+ Note that in the assignment there is no space between -I and the path.
This is a kbuild limitation and no space must be present.

#1 lore raw
Quoted 3 lines · Kristian Edlund

I found a few typos, in Documentation/kbuild/modules.txt
I also changes the $PWD to pwd for consistency throughout the document.

Seriously whitespace-damaged (lost spaces not just at the end of lines, but at their beginning too - and wordwrap etc)

Linus

#2 lore raw
Quoted 5 lines · Linus Torvalds

Seriously whitespace-damaged (lost spaces not just at the end of lines, but at their beginning too - and wordwrap etc)

Linus

I am truely sorry about my patch being broken by my mail program, I have tried to fix it now and is trying to resubmit the patch.

From: Kristian Edlund <[email protected]>

I found a few typos, in Documentation/kbuild/modules.txt
I also changes the $PWD to pwd for consistency throughout the document.

---

modules.txt renamed from modules.txt.orig +0 -0
@@ -38,8 +38,8 @@

What is covered within this file is mainly information to authors of modules. The author of an external modules should supply a makefile that hides most of the complexity so one only has to type -'make' to buld the module. A complete example will be present in -chapter ¤. Creating a kbuild file for an external module". +'make' to build the module. A complete example will be present in +chapter 4. Creating a kbuild file for an external module".

=== 2. How to build external modules
@@ -58,8 +58,8 @@
For the running kernel use:
make -C /lib/modules/uname -r/build M=pwd

-    For the above command to succeed the kernel must have been built with
-    modules enabled.
+    For the above command to succeed the kernel must have been
+    built with modules enabled.

To install the modules that were just built:

@@ -84,14 +84,15 @@
Same functionality as if no target was specified. See description above.

- make -C $KDIR M=$PWD modules_install
+ make -C $KDIR M=pwd modules_install
Install the external module(s).
Installation default is in /lib/modules/<kernel-version>/extra,

-        but may be prefixed with INSTALL_MOD_PATH - see separate chater.
+        but may be prefixed with INSTALL_MOD_PATH - see
+        separate chapter.

- make -C $KDIR M=$PWD clean
+ make -C $KDIR M=pwd clean
Remove all generated files for the module - the kernel
- source directory is not moddified.
+ source directory is not modified.

make -C $KDIR M=pwd help
help will list the available target when building external
@@ -99,8 +100,6 @@

--- 2.3 Available options:

- $KDIR refer to path to kernel src
-
make -C $KDIR
Used to specify where to find the kernel source. '$KDIR' represent the directory where the kernel source is.
@@ -341,7 +340,7 @@
EXTRA_CFLAGS := -Iinclude
8123-y := 8123_if.o 8123_pci.o 8123_bin.o

- Note that in the assingment there is no space between -I and the path.
+ Note that in the assignment there is no space between -I and the path.
This is a kbuild limitation and no space must be present.

#3 lore raw
Quoted 10 lines · Kristian Edlund
Quoted 6 lines · Linus Torvalds

Seriously whitespace-damaged (lost spaces not just at the end of lines, but at their beginning too - and wordwrap etc)

Linus

I am truely sorry about my patch being broken by my mail program, I have tried to fix it now and is trying to resubmit the patch.

I have a similar patch from Brian Strand in my pending queue, I just need a sign-off before I submit it. I fixes a few more spilling mistkates - dunno who has added them in the frist place?? Care to wait two days before applying this one.

Sam