From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Dmitry Gutov Newsgroups: gmane.emacs.devel Subject: Re: master 0339325: ; * lisp/progmodes/project.el (project-current): Doc fix. Date: Mon, 13 Jul 2020 14:09:54 +0300 Message-ID: <3dd1c224-69b2-40af-5b2e-43a310253632@yandex.ru> References: <20200712184908.13140.5739@vcs0.savannah.gnu.org> <20200712184909.BBC61209B1@vcs0.savannah.gnu.org> <7bf4d6ef-c0ec-43dc-ad5d-f6e81422ad90@yandex.ru> <83zh84m5ws.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="2933"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.10.0 Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Jul 13 13:10:41 2020 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1juwM5-0000fF-H0 for ged-emacs-devel@m.gmane-mx.org; Mon, 13 Jul 2020 13:10:41 +0200 Original-Received: from localhost ([::1]:43052 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1juwM4-0006qL-Jv for ged-emacs-devel@m.gmane-mx.org; Mon, 13 Jul 2020 07:10:40 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:37788) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1juwLQ-0006IS-5u for emacs-devel@gnu.org; Mon, 13 Jul 2020 07:10:00 -0400 Original-Received: from mail-wr1-x42d.google.com ([2a00:1450:4864:20::42d]:46284) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1juwLO-0006NT-Bs; Mon, 13 Jul 2020 07:09:59 -0400 Original-Received: by mail-wr1-x42d.google.com with SMTP id r12so15869244wrj.13; Mon, 13 Jul 2020 04:09:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=IBvqxcV1EIbRW+AnauCCCAz7Y0N1qGQQIGled6vjNoI=; b=CS+6NRtrw18V8XXNCzL8lE2jM+Tj5/hfVQkjx70DYAdmB+wS8DdzaGRE0qQOEiD9uv fjyaVi7WWxuYOhfEl598cPMOBCTun5wkVAGW5Cw2qwWCbovIZavBh+6ZN35BF2KnbEML bDchiUUdKELJ44Ui400rmLikwE9YRsc6vL71iJy+FYh/8CAEgyDh/GArZMOMC3cr8J5P i6+7/Hd9068xhIhIC6qu7vMy9wJAQCCsfSalBs3l70eBU40aGBXz9HkRvTSiz/7VAN3n jDPHZFfffH94dKOKehEVSK2+5FF6BrAjtM59o7uSypdyqBxNd8jkOc9ewzApwauwe6yf hUnQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:subject:to:cc:references:from:message-id :date:user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=IBvqxcV1EIbRW+AnauCCCAz7Y0N1qGQQIGled6vjNoI=; b=SZuykTkJ67INS4PlnObgBa7BZza75pqU96Imuo2rEmHG/TMQCtOeLROL1sNfka/bVg XN4ZR9NN42U7h5vcRtw2CyL0y7DEdlk9GdFsNMfXpg6BuQQsP4CIrmIo/0RflzdGdTR/ 9FqLWmPWjcwn2otghIDQeoW7n3YU2+mGoF+ZGqIN4brY71hP1Ox048zXCRSBHDRwpBcg qtRTGQjqdUSt7lLHkrs2h3Bt8bza8LAKNZ+Uh9HIVY5XANiP/CSsJf52gbpAF06oVyHm 0vgjFCZHHKiA7nd3wuTboWNA+Dn9rTdrJU2MWzHTuGFX39rf3NslCvprN+zTI8epK0Ck AaqQ== X-Gm-Message-State: AOAM531biu0B+rU9jq1y0lxFvPff2M4tHJVT+4rIgwApaF1bVgY8K/ir 1wujsEIVE/vYaZepjdFJrlKZaZfz X-Google-Smtp-Source: ABdhPJzOB+TZov368sXyyF3NhxsBZfWTQxRtutciUYgh6nr4BDd7yWEfL4TjTGZvHh9OXEPUfgV2SQ== X-Received: by 2002:a5d:44d1:: with SMTP id z17mr78120209wrr.259.1594638596178; Mon, 13 Jul 2020 04:09:56 -0700 (PDT) Original-Received: from [192.168.0.3] ([66.205.73.129]) by smtp.googlemail.com with ESMTPSA id j16sm23633852wrt.7.2020.07.13.04.09.55 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 13 Jul 2020 04:09:55 -0700 (PDT) In-Reply-To: <83zh84m5ws.fsf@gnu.org> Content-Language: en-US Received-SPF: pass client-ip=2a00:1450:4864:20::42d; envelope-from=raaahh@gmail.com; helo=mail-wr1-x42d.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: 0 X-Spam_score: 0.0 X-Spam_bar: / X-Spam_report: (0.0 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FORGED_FROMDOMAIN=1, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:252910 Archived-At: On 13.07.2020 06:48, Eli Zaretskii wrote: >> From: Dmitry Gutov >> Date: Sun, 12 Jul 2020 23:07:46 +0300 >> >> On 12.07.2020 21:49, Eli Zaretskii wrote: >>> The \"transient\" project instance is a special kind of value >>> which denotes a project rooted in that directory and includes all >>> -files under it except for ones that match standard ignores. >>> +the files under the directory except for those that should be >>> +ignored (per `project-ignores'). >> >> The more accurate way to say this > > What isn't accurate in what I wrote? (The point being that 'standard > ignores" is something never mentioned in any other function or > variable in project.el, and so this term is unknown and confusing.) You were right to change it, but I'm talking about a further improvement. >> except for those that are ignored >> in the default 'project-ignores' implementation. >> >> But this is basically a tautology. If we wanted to describe transient's >> particular behavior we'd have to describe what it actually ignores (and >> it honors vc-directory-exclusion-list as well as >> grep-find-ignored-files). But that pretty clunky for one docstring. > > Which is why I just mentioned the function which implements all that. Thing is, it's a generic function. It has multiple implementations, so saying 'per project-ignores' is not very informative. >> So >> perhaps that description should move somewhere. Into the Commentary, >> maybe. Or directly to the cl-defgeneric's docstring, to which >> project-current's docstring would after all refer to as "the default >> `project-ignores' implementation". > > You cannot usefully refer to the default implementation without saying > that this or that types of project use the default implementation, > which is IMO against your information encapsulation policies. I think I see the reason for your choice. But I'm saying we can describe the behavior of project-ignores for that value. Like we already described the behavior of 'project-root' for that value earlier in the same sentence ("denotes a project rooted in that directory"). While in general we might not want the consumers of project-current depend on particular behavior of either of these generic functions when using backends retrieved in the "normal" way, this is a special, fallback case that can inform the user of the behavior of said fallback backend. If we had a better place to describe that behavior in, though, we could move that there.