localmodconfig: Document localmodconfig in README

Someone (over a year ago :-p) asked me to document localmodconfig in the README file in the source code. I thought it was a good idea but other things were more important and I simply forgot about it. Well, I stumbled on the email asking me about this and I'm sending it out now. Signed-off-by: Steven "Mr. Procrastinator" Rostedt <rostedt@goodmis.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

localmodconfig: Document localmodconfig in README
Someone (over a year ago :-p) asked me to document localmodconfig in the README file in the source code. I thought it was a good idea but other things were more important and I simply forgot about it. Well, I stumbled on the email asking me about this and I'm sending it out now. Signed-off-by: Steven "Mr. Procrastinator" Rostedt <rostedt@goodmis.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Steven Rostedt · Linus Torvalds
1 parent d8dc91b753
Showing 1 changed file with 18 additions and 0 deletions Side-by-side Diff
README
@@ -206,6 +206,24 @@
      "make randconfig"  Create a ./.config file by setting symbol
                         values to random values.
  
+     "make localmodconfig" Create a config based on current config and
+                           loaded modules (lsmod). Disables any module
+                           option that is not needed for the loaded modules.
+
+                           To create a localmodconfig for another machine,
+                           store the lsmod of that machine into a file
+                           and pass it in as a LSMOD parameter.
+
+                   target$ lsmod > /tmp/mylsmod
+                   target$ scp /tmp/mylsmod host:/tmp
+
+                   host$ make LSMOD=/tmp/mylsmod localmodconfig
+
+                           The above also works when cross compiling.
+
+     "make localyesconfig" Similar to localmodconfig, except it will convert
+                           all module options to built in (=y) options.
+
    You can find more information on using the Linux kernel config tools
    in Documentation/kbuild/kconfig.txt.
...	...	@@ -206,6 +206,24 @@
206	206	"make randconfig" Create a ./.config file by setting symbol
207	207	values to random values.
208	208
	209	+ "make localmodconfig" Create a config based on current config and
	210	+ loaded modules (lsmod). Disables any module
	211	+ option that is not needed for the loaded modules.
	212	+
	213	+ To create a localmodconfig for another machine,
	214	+ store the lsmod of that machine into a file
	215	+ and pass it in as a LSMOD parameter.
	216	+
	217	+ target$ lsmod > /tmp/mylsmod
	218	+ target$ scp /tmp/mylsmod host:/tmp
	219	+
	220	+ host$ make LSMOD=/tmp/mylsmod localmodconfig
	221	+
	222	+ The above also works when cross compiling.
	223	+
	224	+ "make localyesconfig" Similar to localmodconfig, except it will convert
	225	+ all module options to built in (=y) options.
	226	+
209	227	You can find more information on using the Linux kernel config tools
210	228	in Documentation/kbuild/kconfig.txt.
211	229