Skip to contentSkip to conversation

Updated docu for srm_env.o driver

Docu-PATCH Jan-Benedict Glaw 2 participants 2 messages Jun 5, 2002 – Jun 6, 2002 Alpha port

lore
Share & tools
lore
#0 lore raw

Hi Linus!

Please apply this patch. It updates the documentation to my driver.

MfG, JBG

arch/alpha/Config.help renamed from arch/alpha/Config.help.orig +7 -6
@@ -570,13 +570,14 @@
   unless you really know what this hack does.
 
 CONFIG_SRM_ENV
-  If you enable this option, a subdirectory called srm_environment
-  will give you access to the most important SRM environment
-  variables. If you've got an Alpha style system supporting
-  SRC, then it is a good idea to say Yes or Module to this driver.
+  If you enable this option, you'll find all important SRM environment
+  variables in /proc/srm_environment/named_variables/. In addition to
+  this, you can access any custom variable through its assigned number
+  in /proc/srm_environment/numbered_variables/. If you want to access
+  your SRM environment (or if you're building a generic kernel for
+  distribution) it's a good idea to say Y or M to this driver.
 
-  This driver is also available as a module and will be called
-  srm_env.o if you build it as a module.
+  If you build it as a module, the resulting file will be srm_env.o.
 
 CONFIG_DEBUG_KERNEL
   Say Y here if you are developing drivers or trying to debug and
Signature · 3 lines
Jan-Benedict Glaw   .   [email protected]   .   +49-172-7608481
	 -- New APT-Proxy written in shell script --
	   http://lug-owl.de/~jbglaw/software/ap2/
#1 lore raw

arch/alpha/Config.help line 580

Quoted 10 lines · Jan-Benedict Glaw

Please apply this patch. It updates the documentation to my driver.

arch/alpha/Config.help renamed from arch/alpha/Config.help.orig +7 -0
+  If you enable this option, you'll find all important SRM environment
+  variables in /proc/srm_environment/named_variables/. In addition to
+  this, you can access any custom variable through its assigned number
+  in /proc/srm_environment/numbered_variables/. If you want to access
+  your SRM environment (or if you're building a generic kernel for
+  distribution) it's a good idea to say Y or M to this driver.
 
+  If you build it as a module, the resulting file will be srm_env.o.

After reading this, I still don't know what SRM is. Could you possibly expand SRM in the first line so it makes sense for te not-so-clued-up? E.g.:

"If you enable this option, the important Silly Random Memo (SRM) confguration settings are stored in /proc/srm_environment/ ..."

Thanks,

Ruth

Signature · 2 lines
Ruth Ivimey-Cook
Software engineer and technical writer.