Denton Liu <liu.den...@gmail.com> writes:

> After looking through the source files in compat/ and investigating the
> files' content and/or its Git history, I've determined the list of files
> that were copied from a third-party source. Place the names of these
> files into the THIRD_PARTY_SOURCES variable in the Makefile.

Please make sure readers won't get fooled into thinking these are
filenames.  They are meant to be used in $(filter-out) as patterns
to match the names of third-party source files.

Also, the paragraph before that talks about "I did this", but
claiming credit is much less important than why we are doing this in
the first place, which you forgot to say (perhaps because you were
too deeply into the task and the motivation was too obvious to you).

So, if I were doing this patch, I'd justify the whole thing as such:

        Some files in our codebase are borrowed from other projects,
        and minimally updated to suit our own needs.  We'd sometimes
        need to tell our own sources and these third-party sources
        apart for management purposes (e.g. we may want to be less
        strict about coding style and other issues on third-party
        files).

        Define the $(MAKE) variable THIRD_PARTY_SOURCES that can be
        used to match names of third-party sources.


>  
> +THIRD_PARTY_SOURCES += compat/inet_ntop.c
> +THIRD_PARTY_SOURCES += compat/inet_pton.c
> +THIRD_PARTY_SOURCES += compat/obstack.%
> +THIRD_PARTY_SOURCES += compat/nedmalloc/%
> +THIRD_PARTY_SOURCES += compat/poll/%
> +THIRD_PARTY_SOURCES += compat/regex/%
> +THIRD_PARTY_SOURCES += sha1collisiondetection/%
> +THIRD_PARTY_SOURCES += sha1dc/%

Before this block, please explain that this is meant to be a list of
patterns suitable for $(filter-out) and friends in a comment.

Thanks.

Reply via email to