Re: [2.6 patch] Canonically reference files in Documentation/ code comments part

From: Adrian Bunk
Date: Sat Apr 24 2004 - 10:42:40 EST


On Sat, Apr 24, 2004 at 09:56:28AM +0100, Russell King wrote:
> On Sat, Apr 24, 2004 at 01:10:58AM +0200, Adrian Bunk wrote:
> > Below is an updated version of a patch by
> > Hans Ulrich Niedermann <linux-kernel@xxxxxxxxxxxxxxxx> to
> > change all references in comments to files in Documentation/ to start
> > with Documentation/ .
>
> I'd prefer to include the 'linux/' part so its obvious that we're
> referring to the kernel tree. I've given people pointers to files
> in the past, and just giving "Documentation/foo/bar" usually results
> in "I've looked on the web here, there and somewhere else and can't
> find the file."

Arguments in favor of this patch:
- it's more common in the kernel to start the reference at the top
of the kernel source
- the name of the directory os not linux but linux-<version>

But I don't have a that strong opinion on this issue.

cu
Adrian

--

"Is there not promise of rain?" Ling Tan asked suddenly out
of the darkness. There had been need of rain for many days.
"Only a promise," Lao Er said.
Pearl S. Buck - Dragon Seed

-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/