Re: [patch v2] doc: DMA-mapping.txt has undeclared variables [Bug 10397]

[Jesse Barnes]

On Wednesday, April 09, 2008 11:45 am Grant Grundler wrote:
> On Mon, Apr 07, 2008 at 09:05:51AM -0700, Jesse Barnes wrote:
> > On Monday, April 07, 2008 9:01 am Matti Linnanvuori wrote:
> > > From: Matti Linnanvuori <mattilinnanvuori@xxxxxxxxx>
> > >
> > > Fix undeclared variables in code examples.
> > > Consistently use pdev as the variable of type struct pci_dev *.
> > > Bug 10397.
> >
> > I think Grant's comment still stands, "fix undeclared variables" isn't an
> > accurate description of what you're doing here...
>
> Yes, please just drop the first sentence. The second sentence is
> sufficient.
>
> > That said, the patch itself looks fine to me, if a bit pedantic.  The
> > compiler will catch any mismatched arguments in this case, and the rest
> > of the documentation is pretty clear that these routines take struct
> > pci_dev not struct device, so I'd be inclined to just leave it the way it
> > is to avoid churn.
>
> I think it's a good habit to use "pdev" in device drivers and would
> like the documentation to incorporate that.
>
> I'm ok with the churn since it's not conflicting with anything else AFAIK.

Matti, can you post an update with Grant's comments addressed?  It's mainly 
about the changelog comment at this point, which should read something 
like "Update DMA mapping documentation to use 'pdev' rather than 'dev' in 
example code that calls routines expecting 'struct pci_device *', since 'dev' 
might make readers think they're passing 'struct device *' parameters."

Assuming it looks ok I'll go ahead and put it into the PCI tree.

Thanks,
Jesse

--
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/