[cmake-developers] Adding argument "OPTIONAL" to find_package() and add_subdirectory

[Alexander Neundorf]

On Monday 20 June 2011, Brad King wrote:
> On 06/20/2011 12:40 PM, Alexander Neundorf wrote:
> > On Monday 20 June 2011, Brad King wrote:
> >> - In the documentation patch please move mention of this variable down
> >> 
> >>   to the bottom.  It is not important information for general authors
> >>   learning the command.  Certainly this information does not belong
> >>   in the short usage summary section above the full command signature.
> > 
> > Well, I put it at the end of the "simple" documentation and before the
> > details, because IMO it is for users of the package and not for
> > developers (which may need the details), so I thought it should be
> > relatively early.
> > 
> > But I don't have a strong opinion on that.
> 
> Since it is a variable and not an argument to the command I suggest that
> it be added to cmDocumentVariables too.  Put the full detailed description
> there and perhaps also describe the intended use case.  Then just add a
> once-sentence summary and reference to the variable at the end of the
> find_package details documentation.  That way you can add as much detail
> as we need without cluttering the main command documentation.

I moved part of the documentation now to the variable section.

Better ?

While looking at it, I'm not sure anymore the name 
"DISABLE_FIND_PACKAGE_<Name>" is good.

Should it maybe have the "CMAKE_" prefix ?

CMAKE_DISABLE_FIND_PACKAGE_<Name> ?
or 
CMAKE_FIND_PACKAGE_DISABLE_<Name> ?

Alex