login
Login
/
Register
Search
Search this site:
Forums
News
Blogs
Features
Site
Home
»
Mailing list archives
»
linux-kernel
»
2008
»
April
»
11
Re: [DOC PATCH] semaphore documentation
view
thread
Previous message: [
thread
] [
date
] [
author
]
Next message: [
thread
] [
date
] [
author
]
[view in full thread]
From: Randy Dunlap
Subject:
Re: [DOC PATCH] semaphore documentation
Date: Friday, April 11, 2008 - 1:27 pm
On Fri, 11 Apr 2008 13:21:54 -0600 Matthew Wilcox wrote:
quoted text
> On Thu, Apr 10, 2008 at 03:19:07PM -0700, Andrew Morton wrote: > > On Thu, 10 Apr 2008 16:08:16 -0600 > > Matthew Wilcox <matthew@wil.cx> wrote: > > > It seems very strange to me to document the API with the implementation > > > rather than with the declaration. It's almost as if we expect people to > > > have to read the implementation to figure out how stuff works. > > > > That approach makes sense for C++. But for C, the code is .c-centric. > > I've never programmed in C++ ... I just expect to find API documentation > in header files. > > > That's particularly the case with the kernel, where we explicitly work to > > make the .c files the things which people look at, while not caring about > > the .h files. Look at how much we say "get that ifdef out of there and > > hide it in the header file". > > I see that as being "move the complexity around" and "get the interfaces > right", not "hide it in the header files where nobody ever looks". > > > > How about a note in semaphore.c that says "refer to semaphore.h for > > > usage information"? > > > > No, please document it in the C file, where people expect to find it. > > Fine, I've done it the other way round. > > Please review this doc-patch. Without comments, I'll commit it to the > semaphore git tree tomorrow.
Looks good to me. Thanks. --- ~Randy --
unsubscribe notice
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to
majordomo@vger.kernel.org
More majordomo info at
http://vger.kernel.org/majordomo-info.html
Please read the FAQ at
http://www.tux.org/lkml/
Previous message: [
thread
] [
date
] [
author
]
Next message: [
thread
] [
date
] [
author
]
Messages in current thread:
[DOC PATCH] semaphore documentation
, Matthew Wilcox
, (Fri Apr 11, 12:21 pm)
Re: [DOC PATCH] semaphore documentation
, Randy Dunlap
, (Fri Apr 11, 1:27 pm)
Re: [DOC PATCH] semaphore documentation
, Andrew Morton
, (Fri Apr 11, 10:09 pm)
Re: [DOC PATCH] semaphore documentation
, Matthew Wilcox
, (Sat Apr 12, 7:12 am)
Re: [DOC PATCH] semaphore documentation
, Andrew Morton
, (Sat Apr 12, 12:27 pm)
Re: [DOC PATCH] semaphore documentation
, David Woodhouse
, (Tue Apr 15, 1:24 am)
Navigation
Mailing list archives
Recent posts
Popular discussions
linux-kernel
:
Fortier,Vincent [Montreal]
2.6.21.5 june 30th to july 1st date hang?
Jeff Dike
[ PATCH 2/6 ] UML - Formatting fixes around os_{read_write}_file callers
Liam Girdwood
[PATCH 07/13] regulator: regulator test harness
Oleg Nesterov
Re: Getting the new RxRPC patches upstream
Stefan Seyfried
Re: 2.6.19-rc5: grub is much slower resuming from suspend-to-disk than in 2.6.18
linux-netdev
:
Arnaud Ebalard
Re: [REGRESSION,BISECTED] MIPv6 support broken by f4f914b58019f0
Jan Engelhardt
Re: [PATCH iptables] extension: add xt_cpu match
Jarek Poplawski
Re: [PATCH] pkt_sched: Destroy gen estimators under rtnl_lock().
Sebastian Andrzej Siewior
[PATCH 8/8] net/emergency: remove locking from reycling pool if emergncy pools are...
David Miller
Re: [PATCH] qlcnic: dont assume NET_IP_ALIGN is 2
git
:
Jakub Narebski
Re: git on MacOSX and files with decomposed utf-8 file names
Brandon Casey
Re: Thunderbird and patches (was Re: [PATCH v2] Enable setting attach as the def...
Christian Couder
[PATCH 1/3] rev-parse: add test script for "--verify"
Ramkumar Ramachandra
Re: [GSoC update] git-remote-svn: The final one
Junio C Hamano
Re: git-rm isn't the inverse action of git-add
openbsd-misc
:
Joachim Schipper
Re: UVC Webcams
Florin Andrei
SOLVED [was: firewall is very slow, something's wrong]
Todd Alan Smith
Re: Microsoft gets the Most Secure Operating Systems award
Neal Hogan
Re: Need Advice: Thinkpad T60 or T61?
Sam Fourman Jr.
Re: Real men don't attack straw men
git-commits-head
:
Linux Kernel Mailing List
ACPI: Disable ARB_DISABLE on platforms where it is not needed
Linux Kernel Mailing List
m68knommu: add read_barrier_depends() and irqs_disabled_flags()
Linux Kernel Mailing List
[MTD] Add mtd panic_write function pointer
Linux Kernel Mailing List
[ARM] pxa: remove duplicate select statements from Kconfig
Linux Kernel Mailing List
mlx4_core: Don't read reserved fields in mlx4_QUERY_ADAPTER()
Colocation donated by:
Syndicate