Re: [PATCH -v2 1/2] build: union: Add create-all-directories? parameter to union-build

[huang ying]

On Wed, Mar 8, 2017 at 4:35 AM, Danny Milosavljevic
<address@hidden> wrote:
> Hi,
>
> On Tue,  7 Mar 2017 19:07:48 +0800
> Huang Ying <address@hidden> wrote:
>
>> * guix/build/union.scm (union-build): Add create-all-directories? keyword
>>   parameter.  To add/remove some files from the directory.
>
> Maybe without "To add/remove some files from the directory." ?
>
> If you'd like to document your new functionality, please update the docstring 
> in the source code - it's not like we read the git log for API documentation.

Sure.

> The source code currently says:
>
>  "Build in the OUTPUT directory a symlink tree that is the union of all
>  the INPUTS."
>
> and it could be updated to say:
>
>  "Build in the OUTPUT directory a symlink tree that is the union of all
>   the INPUTS.  As a special case, if CREATE-ALL-DIRECTORIES?, creates
>   the direct subdirectories in the output directory to make sure the
>   user can add to them later."

Will change the docstring as this.  Maybe change "user" to "caller" to
emphasize the end user will not change the directories.

> Otherwise LGTM!

Thanks!

Best Regards,
Huang, Ying