[tarantool-patches] Re: [PATCH v2 4/4] Extract 'coll' library from 'core'

[Vladislav Shpilevoy <v.shpilevoy@tarantool.org>]

On 26/02/2019 15:55, Konstantin Osipov wrote:
> * Vladislav Shpilevoy <v.shpilevoy@tarantool.org> [19/02/26 15:42]:
> 
>> We usually do not put such dependency links in any
>> library headers. A programmer can look at CMakeLists,
>> if he needs to know them. Secondly, it complicates update -
>> when we added or removed a dependency, we would have
>> had to update two files - source and CMakeLists.txt.
>> Thirdly, even if you added as a dependency a static library,
>> but did not add its own dependencies, it is ok - cmake
>> handles that.
> 
> OK, but a library is a standalone thing and it does need a README
> file - describing its purpose, scope, dependencies, limitations.
> 
> Don't you think so?
> 

Usually we either do not write readme at all, or write it in
the main header, describing the main functionality. And it is
never about build details, dependencies, and limitations.

All limitations are usually described with corresponding enum
values and function comments.

> -- 
> Konstantin Osipov, Moscow, Russia, +7 903 626 22 32
> http://tarantool.io - www.twitter.com/kostja_osipov
>