[pacman-dev] [PATCH 3/3] makepkg: document environment variables PKGDEST and SRCDEST

[Dan McGee]

On Thu, Dec 3, 2009 at 3:17 AM, Allan McRae <allan at archlinux.org> wrote:
> Cedric Staniewski wrote:
>>
>> On 12/03/2009 05:19 AM, Allan McRae wrote:
>>>
>>> Cedric Staniewski wrote:
>>>>
>>>> Signed-off-by: Cedric Staniewski <cedric at gmx.ca>
>>>> ---
>>>>  doc/makepkg.8.txt |   15 +++++++++++++++
>>>>  1 files changed, 15 insertions(+), 0 deletions(-)
>>>>
>>>> diff --git a/doc/makepkg.8.txt b/doc/makepkg.8.txt
>>>> index 703c1b0..ccb9a28 100644
>>>> --- a/doc/makepkg.8.txt
>>>> +++ b/doc/makepkg.8.txt
>>>> @@ -170,6 +170,21 @@ Environment Variables
>>>>     must be supported by this command. If the variable is not set or
>>>>     empty, makepkg will fall back to `pacman'.
>>>>  +**PKGDEST=**"/path/to/folder"::
>>>> +    If this value is not set, packages will by default be placed in the
>>>> +    current directory (location of the linkman:PKGBUILD[5]). Many
>>>> people
>>>> +    like to keep all their packages in one place so this option allows
>>>> +    this behavior. A common location is ``/home/packages''.
>>>> +    This environment variable will override the corresponding value
>>>> +    defined in linkman:makepkg.conf[5].
>>>
>>> I do not like the repetition of makepkg.conf.5 here.  I'd prefer just
>>> **PKGDEST=**"/path/to/folder"::
>>>    Overrides the corresponding value defined in linkman:makepkg.conf[5].
>>>
>>> Or something quite simple like that.  People can then look up
>>> makepkg.conf.5 to find out what the variable does.
>>>
>>>
>>
>> I agree with you. How about
>>
>> **PKGDEST=**"/path/to/folder"::
>>  Folder where the resulting packages will be stored. Overrides the
>> corresponding value defined in linkman:makepkg.conf[5].
>>
>> **SRCDEST=**"/path/to/folder"::
>>  Folder where the downloaded sources will be stored. Overrides the
>> corresponding value defined in linkman:makepkg.conf[5].
>>
>
> Looks good to me.  I'll let Dan comment as he always picks holes in my
> documentation! :P

The hole I will pick is I don't believe this documentation is true.
Why would we prefer an environment variable declaration over a sourced
PKGDEST= set of the value?

-Dan