From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by turing.freelists.org (Avenir Technologies Mail Multiplex) with ESMTP id 6D704268C2 for ; Tue, 26 Feb 2019 08:09:54 -0500 (EST) Received: from turing.freelists.org ([127.0.0.1]) by localhost (turing.freelists.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id hUJwLXE_Rvjs for ; Tue, 26 Feb 2019 08:09:54 -0500 (EST) Received: from smtpng1.m.smailru.net (smtpng1.m.smailru.net [94.100.181.251]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by turing.freelists.org (Avenir Technologies Mail Multiplex) with ESMTPS id A9DD726879 for ; Tue, 26 Feb 2019 08:09:53 -0500 (EST) Subject: [tarantool-patches] Re: [PATCH v2 4/4] Extract 'coll' library from 'core' References: <20190226122357.GF5592@chai> <85771fa1-b999-e3d0-3975-44e8a3d371cd@tarantool.org> <20190226125525.GG5592@chai> From: Vladislav Shpilevoy Message-ID: Date: Tue, 26 Feb 2019 16:09:50 +0300 MIME-Version: 1.0 In-Reply-To: <20190226125525.GG5592@chai> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Sender: tarantool-patches-bounce@freelists.org Errors-to: tarantool-patches-bounce@freelists.org Reply-To: tarantool-patches@freelists.org List-help: List-unsubscribe: List-software: Ecartis version 1.0.0 List-Id: tarantool-patches List-subscribe: List-owner: List-post: List-archive: To: Konstantin Osipov Cc: tarantool-patches@freelists.org On 26/02/2019 15:55, Konstantin Osipov wrote: > * Vladislav Shpilevoy [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 >