[cifs-protocol] [REG:110020359682290] [MS-RPRN] 3.1.4.1.2 Dynamically Typed Query Parameters - Bad variable names

[Jeremy Allison]

On Wed, Feb 03, 2010 at 08:54:36PM +0000, David Wooden wrote:
> Sorry for the re-send, adding our internal tool alias for tracking these issues.
> 
> -----Original Message-----
> From: David Wooden 
> Sent: Wednesday, February 03, 2010 12:52 PM
> To: Jeremy Allison
> Cc: pfif at tridgell.net; cifs-protocol at samba.org
> Subject: [REG:110020359682290] [MS-RPRN] 3.1.4.1.2 Dynamically Typed Query Parameters - Bad variable names
> 
> Hi Jeremy,
> 
> I have created a case for this issue (case number is 110020359682290) and will be working with you on it.
> 
> In reading through this section, I believe that you are correct, since cbBuf is not used previously in this section.
> 
> 
> Since this section is talking about an API pattern rather than a specific API function, it may be that the correct solution is to change...
> 
> "pcbNeeded or pcbData:"
> 
> to
> 
> "pcbNeeded or pcbData or cbBuf:"
> 
> ...because cbBuf is certainly used by some functions in this pattern (as described elsewhere in this document).
> 
> 
> Please let me know your thoughts.  In the meantime, I will dig a little deeper and update you as soon as I have more to add.

I'm not sure I follow the "API pattern" argument. I think each
section should be specific to the variable names used above the
phrase use. After all, the "API pattern" leads to the cut-and-paste
error I just called out. Might be better to standardize the names
across the document in all sections that use them.

Jeremy.