Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a9d38a4f authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge branch 'dunlap' (Randy's Documentation patches) 

Merge Documentation fixes from Randy Dunlap.

Fixed up several small annoyances (bad changelogs and corrupted utf8
names), I need to try to convince people to do things right.

* emailed from Randy Dunlap <rdunlap@xenotime.net>:
  Documentation: fix typo in ABI/stable/sysfs-driver-usb-usbtmc
  Documentation: replace install commands with softdeps
  Documentation: remove references to /etc/modprobe.conf
  Documentation: input.txt: clarify mousedev 'cat' command syntax
  Documentation: CodingStyle: add inline assembly guidelines
  Documentation: sysrq: Crutcher Dunnavant is unavailable
  Documentation: mention scripts/diffconfig tool
  Documentation: remove 'mach' from dontdiff file
parents 9613bebb c4801382

Documentation/ABI/stable/sysfs-driver-usb-usbtmc

+1 −1
Original line number Diff line number Diff line
@@ -55,7 +55,7 @@ What: /sys/bus/usb/drivers/usbtmc/devices/*/auto_abort 
Date:		August 2008

Contact:	Greg Kroah-Hartman <gregkh@linuxfoundation.org>

Description:

		This file determines if the the transaction of the USB TMC

		This file determines if the transaction of the USB TMC

		device is to be automatically aborted if there is any error.

		For more details about this, please see the document,

		"Universal Serial Bus Test and Measurement Class Specification

Documentation/CodingStyle

+29 −0
Original line number Diff line number Diff line
@@ -793,6 +793,35 @@ own custom mode, or may have some other magic method for making indentation 
work correctly.





		Chapter 19:  Inline assembly



In architecture-specific code, you may need to use inline assembly to interface

with CPU or platform functionality.  Don't hesitate to do so when necessary.

However, don't use inline assembly gratuitously when C can do the job.  You can

and should poke hardware from C when possible.



Consider writing simple helper functions that wrap common bits of inline

assembly, rather than repeatedly writing them with slight variations.  Remember

that inline assembly can use C parameters.



Large, non-trivial assembly functions should go in .S files, with corresponding

C prototypes defined in C header files.  The C prototypes for assembly

functions should use "asmlinkage".



You may need to mark your asm statement as volatile, to prevent GCC from

removing it if GCC doesn't notice any side effects.  You don't always need to

do so, though, and doing so unnecessarily can limit optimization.



When writing a single inline assembly statement containing multiple

instructions, put each instruction on a separate line in a separate quoted

string, and end each string except the last with \n\t to properly indent the

next instruction in the assembly output:



	asm ("magic %reg1, #42\n\t"

	     "more_magic %reg2, %reg3"

	     : /* outputs */ : /* inputs */ : /* clobbers */);







		Appendix I: References

Documentation/aoe/aoe.txt

+1 −1
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ CREATING DEVICE NODES 
    sh Documentation/aoe/mkshelf.sh /dev/etherd 0



  There is also an autoload script that shows how to edit

  /etc/modprobe.conf to ensure that the aoe module is loaded when

  /etc/modprobe.d/aoe.conf to ensure that the aoe module is loaded when

  necessary.



USING DEVICE NODES

Documentation/aoe/autoload.sh

+2 −2
Original line number Diff line number Diff line 
#!/bin/sh

# set aoe to autoload by installing the

# aliases in /etc/modprobe.conf

# aliases in /etc/modprobe.d/



f=/etc/modprobe.conf

f=/etc/modprobe.d/aoe.conf



if test ! -r $f || test ! -w $f; then

	echo "cannot configure $f for module autoloading" 1>&2

Documentation/blockdev/floppy.txt

+1 −1
Original line number Diff line number Diff line
@@ -49,7 +49,7 @@ you can put: 


 options floppy omnibook messages



in /etc/modprobe.conf.

in a configuration file in /etc/modprobe.d/.





 The floppy driver related options are: