linux-kernel - Re: [PATCH] pci kernel-doc fatal error

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <1216681665.7427.9.camel@localhost>
Date:	Tue, 22 Jul 2008 09:07:45 +1000
From:	Michael Ellerman <michael@...erman.id.au>
To:	Randy Dunlap <randy.dunlap@...cle.com>
Cc:	lkml <linux-kernel@...r.kernel.org>,
	torvalds <torvalds@...ux-foundation.org>,
	jbarnes@...tuousgeek.org, linux-pci@...r.kernel.org
Subject: Re: [PATCH] pci kernel-doc fatal error

On Mon, 2008-07-21 at 09:27 -0700, Randy Dunlap wrote:
> From: Randy Dunlap <randy.dunlap@...cle.com>
> 
> Fix kernel-doc comments so that they don't produce errors.
> Also cut some extraneous copy-paste text.
> 
> Error(linhead//drivers/pci/pci.c:1133): duplicate section name 'Description'
> Error(linhead//drivers/pci/pci.c:1189): duplicate section name 'Description'

But now the description lines exceed 80 columns, and with longer
function names it's even harder to write a meaningful description in
under 80 columns.

Couldn't kerneldoc be modified to accept multiline descriptions? I know
they're /short/ descriptions, but still.

cheers

ps. I did look at changing kerneldoc to do that myself, but whereas
previously I thought I didn't really know perl, now I /know/ I totally
don't know perl ;)


> --- linhead.orig/drivers/pci/pci.c
> +++ linhead/drivers/pci/pci.c
> @@ -1123,8 +1123,7 @@ int pci_enable_wake(struct pci_dev *dev,
>  }
>  
>  /**
> - * pci_prepare_to_sleep - prepare PCI device for system-wide transition into
> - *                        a sleep state
> + * pci_prepare_to_sleep - prepare PCI device for system-wide transition into a sleep state
>   * @dev: Device to handle.
>   *
>   * Choose the power state appropriate for the device depending on whether
> @@ -1181,8 +1180,7 @@ int pci_prepare_to_sleep(struct pci_dev
>  }
>
>  /**
> - * pci_back_from_sleep - turn PCI device on during system-wide transition into
> - *                       the working state a sleep state
> + * pci_back_from_sleep - turn PCI device on during system-wide transition into working state
>   * @dev: Device to handle.
>   *
>   * Disable device's sytem wake-up capability and put it into D0.

-- 
Michael Ellerman
OzLabs, IBM Australia Development Lab

wwweb: http://michael.ellerman.id.au
phone: +61 2 6212 1183 (tie line 70 21183)

We do not inherit the earth from our ancestors,
we borrow it from our children. - S.M.A.R.T Person

Download attachment "signature.asc" of type "application/pgp-signature" (190 bytes)