Re: [PATCH 2.6.1-rc3] Canonically reference files in Documentation/, code comments part

[Arthur Othieno]

On Thu, Jan 08, 2004 at 07:31:29PM +0100, Hans Ulrich Niedermann wrote:
> diff -Nru a/drivers/usb/misc/tiglusb.c b/drivers/usb/misc/tiglusb.c
> --- a/drivers/usb/misc/tiglusb.c	Thu Jan  8 18:48:58 2004
> +++ b/drivers/usb/misc/tiglusb.c	Thu Jan  8 18:48:58 2004
> @@ -10,7 +10,7 @@
>   *
>   * Based on dabusb.c, printer.c & scanner.c
>   *
> - * Please see the file: linux/Documentation/usb/SilverLink.txt
> + * Please see the file: Documentation/usb/SilverLink.txt

Documentation/silverlink.txt

> diff -Nru a/fs/hfs/FAQ.txt b/fs/hfs/FAQ.txt
> --- a/fs/hfs/FAQ.txt	Thu Jan  8 18:48:58 2004
> +++ b/fs/hfs/FAQ.txt	Thu Jan  8 18:48:58 2004
> @@ -264,7 +264,7 @@
>    mount option.  More information is provided in the ``afpd'' subsection
>    of the ``Mount Options'' section of the HFS documentation (HFS.txt if
>    you have the stand-alone HFS distribution or
> -  linux/Documentation/filesystems/hfs.txt if HFS is in your kernel
> +  Documentation/filesystems/hfs.txt if HFS is in your kernel
>    source tree.)

Ok, these are not in Documentation/ like they should be (funny how they
reference themselves there :) but rather in fs/hfs/.

> diff -Nru a/sound/oss/via82cxxx_audio.c b/sound/oss/via82cxxx_audio.c
> --- a/sound/oss/via82cxxx_audio.c	Thu Jan  8 18:48:58 2004
> +++ b/sound/oss/via82cxxx_audio.c	Thu Jan  8 18:48:58 2004
> @@ -10,7 +10,7 @@
>   * NO WARRANTY
>   *
>   * For a list of known bugs (errata) and documentation,
> - * see via-audio.pdf in linux/Documentation/DocBook.
> + * see via-audio.pdf in Documentation/DocBook.
>   * If this documentation does not exist, run "make pdfdocs".
>   */

True only if we did `make pdfdocs'. Perhaps this should be via-audio.tmpl?

Great work.

	Arthur
-- 
Linux is a true multitasking system. Are you?
-
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/