dect
/
linux-2.6
Archived
13
0
Fork 0
This repository has been archived on 2022-02-17. You can view files and clone it, but cannot push or open issues or pull requests.
linux-2.6/Documentation
Randy Dunlap b3fc9941fb [PATCH] CodingStyle updates
Add some kernel coding style comments, mostly pulled from emails
by Andrew Morton, Jesper Juhl, and Randy Dunlap.

- add paragraph on switch/case indentation (with fixes)
- add paragraph on multiple-assignments
- add more on Braces
- add section on Spaces; add typeof, alignof, & __attribute__ with sizeof;
  add more on postfix/prefix increment/decrement operators
- add paragraph on function breaks in source files; add info on
  function prototype parameter names
- add paragraph on EXPORT_SYMBOL placement
- add section on /*-comment style, long-comment style, and data
  declarations and comments
- correct some chapter number references that were missed when
  chapters were renumbered

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Acked-by: Jesper Juhl <jesper.juhl@gmail.com>
Acked-by: Jan Engelhardt <jengelh@gmx.de>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
2006-12-10 09:55:40 -08:00
..
ABI [PATCH] pktcdvd: add sysfs and debugfs interface 2006-12-08 08:28:38 -08:00
DocBook Merge rsync://rsync.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6 2006-12-08 01:07:56 -05:00
RCU [PATCH] rcu: add sched torture type to rcutorture 2006-10-04 07:55:31 -07:00
accounting Fix typos in /Documentation : 'U-Z' 2006-11-30 04:58:40 +01:00
aoe Fix typos in Documentation/: 'D'-'E' 2006-10-03 22:47:42 +02:00
arm Fix typos in Documentation/: 'N'-'P' 2006-10-03 22:52:05 +02:00
block [PATCH] io/storage: Documentation update to as-iosched.txt 2006-12-07 08:39:32 -08:00
cdrom [PATCH] pktcdvd: add sysfs and debugfs interface 2006-12-08 08:28:38 -08:00
connector [CONNECTOR]: Add userspace example code into Documentation/connector/ 2006-08-26 18:42:00 -07:00
console [PATCH] VT binding: Update documentation 2006-06-26 09:58:33 -07:00
cpu-freq Fix typos in /Documentation : Misc 2006-11-30 05:21:10 +01:00
cris Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
crypto [CRYPTO] doc: Update documentation for hash and me 2006-09-21 11:46:20 +10:00
device-mapper [PATCH] Fix dm-snapshot tutorial in Documentation 2005-11-07 07:53:54 -08:00
driver-model Merge master.kernel.org:/pub/scm/linux/kernel/git/gregkh/driver-2.6 2006-12-01 16:41:07 -08:00
drivers/edac [PATCH] Fix and enable EDAC sysfs operation 2006-07-10 13:24:25 -07:00
dvb Fix typos in /Documentation : 'U-Z' 2006-11-30 04:58:40 +01:00
early-userspace earlyuserspace/README: fix homonym err 2005-11-08 17:16:50 +01:00
fault-injection [PATCH] fault-injection: Correct, disambiguate, and reformat documentation 2006-12-08 08:29:03 -08:00
fb Documentation: remove duplicated words 2006-10-03 22:57:56 +02:00
filesystems [PATCH] fs/sysv/: doc cleanup 2006-12-07 08:39:44 -08:00
firmware_class [PATCH] drivers/base/firmware_class.c: cleanups 2006-05-21 12:59:19 -07:00
fujitsu/frv Fix typos in /Documentation : Misc 2006-11-30 05:21:10 +01:00
hwmon k8temp: Documentation update 2006-10-18 13:03:08 -07:00
i2c i2c-viapro: Add support for the VT8237A and VT8251 2006-09-26 15:38:52 -07:00
i2o spelling: s/retreive/retrieve/ 2006-01-10 00:10:13 +01:00
i386 [PATCH] x86-64: Correct documentation for bzImage protocol v2.05 2006-12-07 02:14:13 +01:00
ia64 Documentation: remove duplicated words 2006-10-03 22:57:56 +02:00
infiniband IB/ipoib: Remove broken link from Kconfig and documentation 2006-08-03 10:48:31 -07:00
input Fix typos in /Documentation : Misc 2006-11-30 05:21:10 +01:00
ioctl Fix typos in /Documentation : 'U-Z' 2006-11-30 04:58:40 +01:00
isdn Documentation: remove duplicated words 2006-10-03 22:57:56 +02:00
kbuild Fix typos in /Documentation : Misc 2006-11-30 05:21:10 +01:00
kdump Documentation: remove duplicated words 2006-10-03 22:57:56 +02:00
m68k Documentation: remove duplicated words 2006-10-03 22:57:56 +02:00
mips [MIPS] Fixup migration to GENERIC_TIME 2006-10-31 20:13:23 +00:00
netlabel [NetLabel]: documentation 2006-09-22 14:53:31 -07:00
networking [NETLIK]: Add a pointer to the Generic Netlink wiki page. 2006-12-06 18:39:10 -08:00
parisc Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
pcmcia [PATCH] pcmcia: expose tool in pcmcia/Documentation/pcmcia/ 2006-06-30 22:09:10 +02:00
power [PATCH] s2ram debugging documentation 2006-12-07 08:39:28 -08:00
powerpc [POWERPC] Document describing mpc52xx device tree binding conventions 2006-12-04 20:41:34 +11:00
s390 [S390] Update documentation for dynamic subchannel mapping. 2006-12-08 15:56:02 +01:00
scsi Merge master.kernel.org:/pub/scm/linux/kernel/git/jejb/scsi-misc-2.6 2006-12-05 16:09:46 -08:00
serial [SERIAL] Update parity handling documentation 2006-06-02 17:47:26 +01:00
sh Fix typos in Documentation/: 'H'-'M' 2006-10-03 22:50:39 +02:00
sound Fix typos in /Documentation : 'U-Z' 2006-11-30 04:58:40 +01:00
sparc Fix typos in Documentation/: 'Q'-'R' 2006-10-03 22:54:15 +02:00
spi [PATCH] spi: stabilize PIO mode transfers on PXA2xx systems 2006-12-10 09:55:40 -08:00
sysctl [PATCH] x86: add sysctl for kstack_depth_to_print 2006-12-07 02:14:11 +01:00
telephony Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
uml Fix typos in /Documentation : 'U-Z' 2006-11-30 04:58:40 +01:00
usb Fix typos in /Documentation : Misc 2006-11-30 05:21:10 +01:00
video4linux V4L/DVB (4692): Add WinTV-HVR3000 DVB-T support 2006-10-14 00:43:48 -03:00
vm Documentation: remove duplicated words 2006-10-03 22:57:56 +02:00
w1 [PATCH] w1: Userspace communication protocol over connector. 2006-06-22 11:22:50 -07:00
watchdog Fix typos in /Documentation : 'T'' 2006-11-30 04:55:36 +01:00
x86_64 [PATCH] Calgary: allow compiling Calgary in but not using it by default 2006-12-07 02:14:07 +01:00
00-INDEX Remove long-unmaintained ftape driver subsystem. 2006-12-03 22:22:41 -05:00
BUG-HUNTING Documentation: Update to BUG-HUNTING 2006-03-22 00:37:42 +01:00
Changes Fix typos in doc and comments 2006-11-30 05:32:19 +01:00
CodingStyle [PATCH] CodingStyle updates 2006-12-10 09:55:40 -08:00
DMA-API.txt [PATCH] Pass struct dev pointer to dma_cache_sync() 2006-12-07 08:39:41 -08:00
DMA-ISA-LPC.txt Fix typos in /Documentation : 'T'' 2006-11-30 04:55:36 +01:00
DMA-mapping.txt Documentation: remove duplicated words 2006-10-03 22:57:56 +02:00
HOWTO HOWTO: bug report addition 2006-10-18 12:49:54 -07:00
IO-mapping.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
IPMI.txt [PATCH] IPMI: system interface hotplug 2006-12-07 08:39:47 -08:00
IRQ-affinity.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
IRQ.txt [PATCH] genirq: irq: document what an IRQ is 2006-06-29 10:26:25 -07:00
MSI-HOWTO.txt Fix typos in /Documentation : 'U-Z' 2006-11-30 04:58:40 +01:00
ManagementStyle Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
PCIEBUS-HOWTO.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
README.DAC960 [PATCH] devfs: Last little devfs cleanups throughout the kernel tree. 2006-06-26 12:25:09 -07:00
README.cycladesZ Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
SAK.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
SecurityBugs Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
SubmitChecklist [PATCH] submit checklist: mention headers_check 2006-10-01 00:39:21 -07:00
SubmittingDrivers [PATCH] Documentation/SubmittingDrivers: minor update 2006-09-29 09:18:25 -07:00
SubmittingPatches [PATCH] SubmittingPatches: add a note about "format=flowed" when sending patches 2006-09-29 09:18:25 -07:00
VGA-softcursor.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
acpi-hotkey.txt Fix minor documentation typo 2006-04-01 01:49:22 +02:00
applying-patches.txt [PATCH] Docs update: typos, corrections and additions to applying-patches.txt 2006-01-10 08:01:54 -08:00
atomic_ops.txt Spelling fixes for Documentation/atomic_ops.txt 2006-06-26 18:27:35 +02:00
basic_profiling.txt [PATCH] oprofile: report anonymous region samples 2005-06-24 00:06:27 -07:00
binfmt_misc.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
cachetlb.txt [PATCH] Add flush_kernel_dcache_page() API 2006-03-26 08:56:53 -08:00
cciss.txt Fix typos in Documentation/: 'D'-'E' 2006-10-03 22:47:42 +02:00
cli-sti-removal.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
computone.txt remove mentionings of devfs in documentation 2006-10-03 22:17:48 +02:00
cpqarray.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
cpu-hotplug.txt Fix typos in /Documentation : Misc 2006-11-30 05:21:10 +01:00
cpusets.txt [PATCH] cpuset: top_cpuset tracks hotplug changes to node_online_map 2006-09-29 09:18:21 -07:00
cputopology.txt Fix typos in Documentation/: 'D'-'E' 2006-10-03 22:47:42 +02:00
dcdbas.txt [PATCH] dcdbas: add Dell Systems Management Base Driver with sysfs support 2005-09-07 16:57:27 -07:00
debugging-modules.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
dell_rbu.txt Fix typos in Documentation/: 'N'-'P' 2006-10-03 22:52:05 +02:00
devices.txt [PATCH] New updated devices.txt - LANANA 2006-12-07 08:39:45 -08:00
digiepca.txt typo fixes: aquire -> acquire 2006-06-30 18:23:04 +02:00
dnotify.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
dontdiff dontdiff: add utsrelease.h 2006-09-25 13:33:04 +02:00
ecryptfs.txt [PATCH] ecryptfs: fs/Makefile and fs/Kconfig 2006-10-04 07:55:24 -07:00
eisa.txt Fix typos in /Documentation : 'U-Z' 2006-11-30 04:58:40 +01:00
exception.txt Documentation: remove duplicated words 2006-10-03 22:57:56 +02:00
feature-removal-schedule.txt ieee1394: conditionally export ieee1394_bus_type 2006-12-07 23:12:02 +01:00
floppy.txt [PATCH] kernel Doc/ URL corrections 2005-11-22 09:14:30 -08:00
hayes-esp.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
highuid.txt Fix "can not" in Documentation and Kconfig 2006-10-03 22:53:09 +02:00
hpet.txt Documentation/hpet.txt typo 2006-01-15 02:09:54 +01:00
hrtimers.txt Fix typos in Documentation/: 'S' 2006-10-03 22:55:17 +02:00
hw_random.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
ibm-acpi.txt ACPI: ibm_acpi: delete obsolete documentation 2006-10-14 01:53:32 -04:00
ide.txt Fix typos in /Documentation : 'U-Z' 2006-11-30 04:58:40 +01:00
initrd.txt [PATCH] documentation: Documentation/initrd.txt 2006-07-31 13:28:44 -07:00
io_ordering.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
ioctl-number.txt [PATCH] mbxfb: Document the new ioctl 2006-12-08 08:29:06 -08:00
iostats.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
irqflags-tracing.txt [PATCH] lockdep: irqtrace subsystem, docs 2006-07-03 15:27:03 -07:00
isapnp.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
java.txt Fix "can not" in Documentation and Kconfig 2006-10-03 22:53:09 +02:00
kernel-doc-nano-HOWTO.txt [PATCH] update some docbook comments 2006-11-03 12:27:56 -08:00
kernel-docs.txt remove mentionings of devfs in documentation 2006-10-03 22:17:48 +02:00
kernel-parameters.txt [PATCH] fault injection: documentation and scripts 2006-12-08 08:29:02 -08:00
keys-request-key.txt [PATCH] Keys: Allow in-kernel key requestor to pass auxiliary data to upcaller 2006-06-29 10:26:20 -07:00
keys.txt Fix typos in /Documentation : Misc 2006-11-30 05:21:10 +01:00
kobject.txt Fix typos in Documentation/: 'D'-'E' 2006-10-03 22:47:42 +02:00
kprobes.txt [PATCH] Don't give bad kprobes example aka ") < 0))" typo 2006-11-16 11:43:38 -08:00
kref.txt [PATCH] kref: add link to original documentation to the kref documentation. 2005-04-18 21:57:30 -07:00
laptop-mode.txt Fix typos in /Documentation : Misc 2006-11-30 05:21:10 +01:00
ldm.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
leds-class.txt [PATCH] LED: class documentation 2006-03-31 12:18:56 -08:00
lockdep-design.txt [PATCH] fix lockdep-design.txt 2006-10-11 11:14:24 -07:00
locks.txt [PATCH] Docs update: remove obsolete patch from locks.txt 2006-01-10 08:01:54 -08:00
logo.gif Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
logo.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
magic-number.txt [PATCH] mm: rename kmem_cache_s to kmem_cache 2005-11-07 07:53:24 -08:00
mandatory.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
mca.txt Fix some typos in Documentation/: 'A' 2006-10-03 22:45:33 +02:00
md.txt Fix typos in Documentation/: 'Q'-'R' 2006-10-03 22:54:15 +02:00
memory-barriers.txt Fix typos in /Documentation : 'T'' 2006-11-30 04:55:36 +01:00
memory.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
mono.txt Fix "can not" in Documentation and Kconfig 2006-10-03 22:53:09 +02:00
moxa-smartio Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
mtrr.txt [PATCH] Doc: fix mtrr userspace programs to build cleanly 2006-04-11 06:18:44 -07:00
mutex-design.txt [PATCH] mutex subsystem, documentation 2006-01-09 15:59:20 -08:00
nbd.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
nfsroot.txt Fix typos in Documentation/: 'D'-'E' 2006-10-03 22:47:42 +02:00
nmi_watchdog.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
nommu-mmap.txt [PATCH] NOMMU: Make futexes work under NOMMU conditions 2006-09-27 08:26:15 -07:00
numastat.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
oops-tracing.txt [PATCH] doc: refer to kdump in oops-tracing.txt 2006-01-11 18:42:10 -08:00
paride.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
parport-lowlevel.txt [PATCH] parport: fix documentation 2006-02-03 08:32:06 -08:00
parport.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
pci-error-recovery.txt Documentation: remove duplicated words 2006-10-03 22:57:56 +02:00
pci.txt [PATCH] irq-flags: documentation: Use the new IRQF_ constants 2006-07-02 13:58:55 -07:00
pcieaer-howto.txt PCI-Express AER implemetation: aer howto document 2006-09-26 17:43:52 -07:00
pi-futex.txt fix a typo in Documentation/pi-futex.txt 2006-10-03 23:39:02 +02:00
pm.txt Fix "can not" in Documentation and Kconfig 2006-10-03 22:53:09 +02:00
pnp.txt Fix typos in /Documentation : 'U-Z' 2006-11-30 04:58:40 +01:00
preempt-locking.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
prio_tree.txt Documentation: remove duplicated words 2006-10-03 22:57:56 +02:00
ramdisk.txt [PATCH] Update ramdisk documentation 2006-07-14 21:53:53 -07:00
riscom8.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
robust-futex-ABI.txt Fix typos in /Documentation : 'U-Z' 2006-11-30 04:58:40 +01:00
robust-futexes.txt Fix typos in /Documentation : Misc 2006-11-30 05:21:10 +01:00
rocket.txt Fix typos in Documentation/: 'S' 2006-10-03 22:55:17 +02:00
rpc-cache.txt Documentation: remove duplicated words 2006-10-03 22:57:56 +02:00
rt-mutex-design.txt [PATCH] typo fixes for rt-mutex-design.txt 2006-10-01 00:39:24 -07:00
rt-mutex.txt [PATCH] pi-futex: rt mutex docs 2006-06-27 17:32:47 -07:00
rtc.txt [PATCH] Documentation/rtc.txt updates (for rtc class) 2006-11-25 13:28:33 -08:00
sched-arch.txt [PATCH] sched: resched and cpu_idle rework 2005-11-09 07:56:33 -08:00
sched-coding.txt Fix typos in Documentation/: 'H'-'M' 2006-10-03 22:50:39 +02:00
sched-design.txt Fix typos in Documentation/: 'H'-'M' 2006-10-03 22:50:39 +02:00
sched-domains.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
sched-stats.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
serial-console.txt [PATCH] doc: more serial-console info 2006-03-25 08:23:00 -08:00
sgi-ioc4.txt [PATCH] ioc4: Core driver rewrite 2005-06-21 18:46:32 -07:00
sgi-visws.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
sharedsubtree.txt Fix typos in /Documentation : 'T'' 2006-11-30 04:55:36 +01:00
smart-config.txt kbuild: remove checkconfig.pl 2006-02-19 09:51:22 +01:00
smp.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
sonypi.txt [PATCH] sonypi SPIC initialisation fix 2005-09-07 16:57:24 -07:00
sparse.txt kbuild: clarify "make C=" build option 2006-09-25 10:10:56 +02:00
specialix.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
spinlocks.txt fix rwlock usage example 2006-03-22 00:19:39 +01:00
stable_api_nonsense.txt [PATCH] i386: always enable regparm 2006-12-07 02:14:12 +01:00
stable_kernel_rules.txt Fix typos in /Documentation : Misc 2006-11-30 05:21:10 +01:00
stallion.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
svga.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
sx.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
sysrq.txt [PATCH] Correct sa'K' description in sysrq.txt 2006-06-25 10:01:13 -07:00
time_interpolators.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
tipar.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
tty.txt [PATCH] Correct tty doc 2006-06-26 09:58:17 -07:00
unicode.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
unshare.txt Documentation: remove duplicated words 2006-10-03 22:57:56 +02:00
voyager.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
xterm-linux.xpm Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
zorro.txt Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00

README.cycladesZ

The Cyclades-Z must have firmware loaded onto the card before it will
operate.  This operation should be performed during system startup,

The firmware, loader program and the latest device driver code are
available from Cyclades at
    ftp://ftp.cyclades.com/pub/cyclades/cyclades-z/linux/